cPanel API 2 Functions - Branding::setbrandingpkgstatus

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function enables or disables the current branding package.

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 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=setbrandingpkgstatus&action="enable"

Note:

For more information, read our Calls from the WHM API documentation.

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Enable the account's current branding package.
$enable_branding = $cpanel->api2(
    'Branding', 'setbrandingpkgstatus',
        array(        
            'action'      => 'enable',
    )
 );

Note:

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.

# Enable the account's current branding package.
my $enable_branding = $cpliveapi->api2(
    'Branding', 'setbrandingpkgstatus',
    {
            'action'      => 'enable',
    }
 );

Note:

For more information, read our Guide to the LiveAPI System.

cPanel Tag System (deprecated)

Warnings:

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 setbrandingpkgstatus action=enable

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 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": "setbrandingpkgstatus",
    "data": [
      {
        "status": "enabled"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Branding"
  }
}

Note:

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

Parameters

Input Type Description Possible values Example

Input	Type	Description	Possible values	Example
`action`	string	Required Whether to enable or disable the account's current branding package.	`enable` `disable`	`enable`

action

string

Required

Whether to enable or disable the account's current branding package.

enable
disable

enable

Returns

Return	Type	Description	Possible values	Example
`status`	string	The action taken.	`enabled` `disabled`	`enabled`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`