Description
This function enables or disables the current branding package.
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=
LiveAPI PHP Class
$cpanel = new CPANEL();
$enable_branding = $cpanel->api2(
'Branding', 'setbrandingpkgstatus',
array(
'action' => 'enable',
)
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $enable_branding = $cpliveapi->api2(
'Branding', 'setbrandingpkgstatus',
{
'action' => 'enable',
}
);
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": "setbrandingpkgstatus",
"data": [
{
"status": "enabled"
}
],
"event": {
"result": 1
},
"module": "Branding"
}
}
Parameters
|
Input
|
Type
|
Description
|
Possible values
|
Example
|
|
action
|
string
|
Required
Whether to enable or disable the account's current branding package.
|
|
enable
|
Returns
|
Return
|
Type
|
Description
|
Possible values
|
Example
|
|
status
|
string
|
The action taken.
|
|
enabled
|
|
result
|
boolean
|
Whether the function succeeded.
|
- 1 — The function succeeded.
- 0 — The function failed.
|
1
|
