cPanel API 2 Functions - Branding::resolve_file - Knowledgebase

Description

This function returns a file's path.

Warning:

We strongly recommend that you use the following UAPI functions instead of this function:

Branding::file — This function retrieves a branding file's path.

Note:

cPanel API 2's Branding module only modifies data for the x3 theme.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Branding&cpanel_jsonapi_func=resolve_file&file=

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Get the path to the file.ext file.
$get_path = $cpanel->api2(
    'Branding', 'resolve_file',
        array(      
            'file'         => 'file.ext',
            'skipdefault'  => '0',
            'checkmain'    => '1',
    )
 );

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Get the path to the file.ext file.
my $get_path = $cpliveapi->api2(
    'Branding', 'resolve_file',
    {
            'file'         => 'file.ext',
            'skipdefault'  => '0',
            'checkmain'    => '1',
    }
 );

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 Output (JSON)

{ 
   "cpanelresult":{ 
      "apiversion":2,
      "func":"resolve_file",
      "data":[ 
         { 
            "file":"file.ext",
            "path":"/usr/local/cpanel/base/frontend/x3/branding/file.ext"
         }
      ],
      "event":{ 
         "result":1
      },
      "module":"Branding"
   }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Input	Type	Description	Possible values	Example
file	string	Required The file.	A valid filename.	file.ext
brandingpkg	string	A branding package name, to only search that package's files. If you do not use this parameter, the function searches all packages.	A valid branding package name.	mybrandingpkg
skipdefault	boolean	Whether to ignore the theme default. This parameter defaults to 0.	1 — Ignore the theme default. 0 — Do not ignore the theme default.	0
checkmain	boolean	Whether to search the main branding directory. This parameter defaults to 0.	1 — Include the main branding directory. 0 — Do not include the main branding directory.	0

Returns

Return	Type	Description	Possible values	Example
file	string	The file's name.	The file input parameter's value.	file.ext
path	string	The path to the file.	The path to the file, relative to the user's home directory.	/usr/local/cpanel/base/frontend/x3/branding/file.ext
exists	boolean	Whether the file exists.	1 — The file exists. 0 — The file does not exist.	1
result	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories