# cPanel API 2 Functions - Branding::resolve_file

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

This function returns a file's path.

div
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](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists.

## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
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](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$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](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


```undefined syntaxhighlighter-pre
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](/guides/guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system).
- 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username Branding resolve_file file=file.ext skipdefault=0 checkmain=1
```

div
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](/cpanel-api-2) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
{  
   "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"
   }
}
```

div
Note:

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

## Parameters

table
colgroup
col
col
col
col
col
thead
tr
th
Input
th
Type
th
Description
th
Possible values
th
Example
tbody
tr
td
code
file
td
em
string
td
p
strong
Required
p
The file.
td
p
A valid filename.
p
br
td
p
code
file.ext
tr
td
code
brandingpkg
td
em
string
td
p
A branding package name, to only search that package's files.
p
If you do not use this parameter, the function searches all packages.
td
A valid branding package name.
td
code
mybrandingpkg
tr
td
code
skipdefault
td
em
Boolean
td
p
Whether to ignore the theme default.
p
This parameter defaults to 
code
0
.
td
ul
li
code
1
 — Ignore the theme default.
li
code
0
 — Do not ignore the theme default.
td
code
0
tr
td
code
checkmain
td
em
Boolean
td
p
Whether to search the main branding directory.
p
This parameter defaults to 
code
0
.
td
ul
li
code
1
 — Include the main branding directory.
li
code
0
 — Do not include the main branding directory.
td
code
0
## Returns

table
colgroup
col
col
col
col
col
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
p
code
file
td
em
string
td
The file's name.
td
The 
code
file
 input parameter's value.
td
code
file.ext
tr
td
code
path
td
em
string
td
The path to the file.
td
p
The path to the file, relative to the user's home directory.
td
code
/usr/local/cpanel/base/frontend/x3/branding/file.ext
tr
td
code
exists
td
em
Boolean
td
Whether the file exists.
td
ul
li
code
1
 — The file exists.
li
code
0
 — The file does not exist.
td
code
1
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1