Description

This function retrieves the current branding package's name.

 

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

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

 

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

 

cpapi2 --user=username Branding getbrandingpkg

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "getbrandingpkg",
    "data": [
      {
        "brandingpkg": "black_ice",
        "brandingpkgname": "black_ice"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Branding"
  }
}

 

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
brandingpkgstring

The branding package name.

  • The name of a branding package on the server.
  • A blank value, if the account uses the system's default ([root]) branding package.
black_ice
brandingpkgnamestringThe branding package name.
  • The name of a branding package on the server.
  • [root], if the account uses the system's default branding package.
black_ice
resultBoolean

Whether the function succeeded.

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