cPanel API 2 Functions - Branding::resolve_file

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function returns a file's path.

Note:

cPanel API 2's Branding module only modifies data for the x3 theme. We removed the x3 theme. For more information, read our cPanel Deprecation Plan documentation.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

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="file.ext"&skipdefault=0&checkmain=1

Note:

For more information, read our Calls from the WHM API documentation.

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',
    )
 );

Note:

For more information, read our Guide to the LiveAPI System.

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',
    }
 );

Note:

For more information, read our Guide to the LiveAPI System.

cPanel Tag System (deprecated)

Warnings:

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

Command Line

cpapi2 --user=username Branding resolve_file file=file.ext skipdefault=0 checkmain=1

Notes:

You must URI-encode values.
username represents your account-level username.
You must run the --user=username option.
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

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 (cPanel >> 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`