Description

This function retrieves the current branding package's status.

 

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=getbrandingpkgstatus

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Get the current branding package's status.
$get_branding_pkg = $cpanel->api2(
    'Branding', 'getbrandingpkgstatus'
 );

 

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Get the current branding package's status.
my $get_branding_pkg = $cpliveapi->api2(
    'Branding', 'getbrandingpkgstatus',
 );

 

cpapi2 --user=username Branding getbrandingpkgstatus

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "getbrandingpkgstatus",
    "data": [
      {
        "status": "enabled",
        "nstatus": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Branding"
  }
}

 

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
statusstring

Whether the branding package is currently enabled.

  • enabled
  • disabled
enabled
nstatusBooleanWhether the branding package is currently enabled.
  • 1 — Enabled.
  • 0 — Disabled.
1
resultBoolean

Whether the function succeeded.

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