Description

This function creates or updates the local.css file.

 

Examples


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

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

 

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

 

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

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "savelocalcss",
    "data": [
      {
        "file": "local.css",
        "path": "/home/user/cpanelbranding/x3//local.css",
        "new": "1"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Branding"
  }
}

 

Parameters

InputTypeDescriptionPossible valuesExample
cssstring

Required

The CSS code to add.

Valid CSS code.

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

 

Returns

ReturnTypeDescriptionPossible valuesExample

file

stringThe updated CSS file.The name of a .css file.local.css
pathstringThe path to the local.css file.The path to the local.css file, relative to the cPanel account's home directory.
/home/user/cpanelbranding/x3//local.css
newBooleanWhether the function created the local.css file.
  • 1 — The function created the local.css file.
  • 0 — The function modified the existing local.css file.
1
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1