cPanel API 2 Functions - Branding::savelocalcss - Knowledgebase

Description

This function creates or updates the local.css file.

Note:

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

To customize the Paper Lantern theme, use UAPI functions. For more information, read our Guide to cPanel Interface Customization documentation.
For more information about x3 theme customizations, read our Legacy Guide to x3 Theme Brandingdocumentation.

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=savelocalcss&css=a%3Ahover%7Bcolor%3A%23666%3Btext-decoration%3Aunderline%3B%EF%BB%BF%7D

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Update the local.css file.
$update_css = $cpanel->api2(
    'Branding', 'savelocalcss',
        array(       
            'css'           => 'a:hover{color:#666;text-decoration:underline;}',
    )
 );

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Update the local.css file.
my $update_css = $cpliveapi->api2(
    'Branding', 'savelocalcss',
    {
            'css'           => 'a:hover{color:#666;text-decoration:underline;}',
    }
 );

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.

Command Line

cpapi2 --user=username Branding savelocalcss css=a%3Ahover%7Bcolor%3A%23666%3Btext-decoration%3Aunderline%3B%7D

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "savelocalcss",
    "data": [
      {
        "file": "local.css",
        "path": "/home/user/cpanelbranding/x3//local.css",
        "new": "1"
      }
    ],
    "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
css	string	Required The CSS code to add.	Valid CSS code.	a:hover{color:#666;text-decoration:underline;}

Input

Type

Description

Possible values

Example

css

string

Required

The CSS code to add.

Valid CSS code.

a:hover{color:#666;text-decoration:underline;}

Returns

Return	Type	Description	Possible values	Example
file	string	The updated CSS file.	The name of a .css file.	local.css
path	string	The path to thelocal.css file.	The path to the local.cssfile, relative to the cPanel account's home directory.	/home/user/cpanelbranding/x3//local.css
new	Boolean	Whether the function created the local.css file.	1 — The function created the local.cssfile. 0 — The function modified the existinglocal.css file.	1
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories