cPanel API 2 Functions - Branding::resolvelocalcss
The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.
Description
This function returns the path to the account's local.css
file.
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.
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=resolvelocalcss&getcss="1"
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 account's local.css file.
$get_css_path = $cpanel->api2(
'Branding', 'resolvelocalcss',
array(
'getcss' => '1',
)
);
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 account's local.css file.
my $get_css_path = $cpliveapi->api2(
'Branding', 'resolvelocalcss',
{
'getcss' => '1',
}
);
For more information, read our Guide to the LiveAPI System.
cPanel Tag System (deprecated)
- 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 resolvelocalcss getcss=1
- 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": "resolvelocalcss",
"data": [
{
"css": "",
"file": "local.css",
"path": "/home/exampleuser/cpanelbranding/x3//local.css",
"exists": 0
}
],
"event": {
"result": 1
},
"module": "Branding"
}
}
Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.
Parameters
Input | Type | Description | Possible values | Example |
---|---|---|---|---|
getcss |
string | Whether to return the file's contents in the This parameter defaults to |
|
|
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
|
string | The local.css file's contents, if the getcss parameter's value is 1 . |
|
a:hover{color:#666;text-decoration:underline;} |
|
string | The local.css file's name. |
The name of a .css file. |
local.css |
path |
string | The path to the file. |
|
/home/exampleuser/cpanelbranding/x3/local.css |
exists |
Boolean | Whether the file exists. |
|
1 |
result |
Boolean | Whether the function succeeded. |
|
1 |