cPanel API 2 Functions - Branding::resolvelocalcss

Description

This function returns the path to the account's local.css file.

Note:

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

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=resolvelocalcss&getcss=

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

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

 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.

 

 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"
  }
}

Note:

Use cPanel's API Shell interface (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 css output parameter. 

 This parameter defaults to 0.

  • 1 — Return the contents.
  • 0 — Do not return the contents. 

 

 1

 

 

Returns

 Return

Type

Description

Possible values

Example

 css

 string

 The local.cssfile's contents, if the getcss input parameter's value is 1. 

 CSS code.

 If the file does not exist or is blank, this parameter returns a blank value.

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

 file

 string

 The local.cssfile's name.

 The name of a .cssfile.

 local.css

 path

 string

 The path to the file.

 The path to thelocal.css file, relative to the user's home directory.

 If the file does not exist, the function returns the most appropriate location in which to create the file. 

 /home/exampleuser/cpanelbranding/x3/local.css 

 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

 

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....