cPanel API 2 Functions - Branding::showpkgs - Knowledgebase

Description

This function lists available branding packages.

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=showpkgs&onlyshowyours=

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// List all custom branding packages.
$list_branding_pkgs = $cpanel->api2(
    'Branding', 'showpkgs',
        array(       
            'onlyshowyours'      => '0',
            'skipglobal'         => '1',
    )
 );

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# List all custom branding packages.
my $list_branding_pkgs = $cpliveapi->api2(
    'Branding', 'showpkgs',
    {
            'onlyshowyours'      => '0',
            'skipglobal'         => '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": "showpkgs",
    "data": [
      {
        "disabled": 0,
        "types": [
          {
            "downloadlinktext": "Download (Yours)",
            "pkg": "mobile",
            "type": "yours"
          }
        ],
        "pkgname": "mobile",
        "previewsmimg": "/cPanel_magic_revision_1327526145/frontend/x3/branding/mobile/previewsm.jpg",
        "selectopt": "selected",
        "pkgchecked": "checked",
        "previewimg": "/cPanel_magic_revision_1327526145/frontend/x3/branding/mobile/preview.jpg",
        "pkg": "mobile",
        "selected": 1
      }
    ],
    "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
onlyshowyours	boolean	Whether to only return the user's branding packages. This parameter defaults to 0.	1 — Only return branding packages that the user owns. 0 — Return all branding packages.	0
showroot	boolean	Whether to only return system branding packages. This parameter defaults to 0.	1 — Only return system branding packages. 0 — Return all branding packages.	0
skipglobal	boolean	Whether to only return customized branding packages. This parameter defaults to 0.	1 — Only return custom branding packages. 0 — Return all branding packages.	1
skiphidden	boolean	Whether to only return branding packages that the user does not own. This parameter defaults to 0.	1 — Only return unowned branding packages. 0 — Return all branding packages.	0

Returns

Return	Type	Description	Possible values	Example
disabled	boolean	Whether the branding package is disabled.	1 — Disabled. 0 — Enabled.	0
types	hash	A hash of branding package type information.	This hash includes thedownloadlinktext, pkg, andtype parameters.
downloadlinktext	string	The branding package's download link text. The function returns this parameter in the typeshash.	Download (Yours) Download (System)	Download (Yours)
pkg	string	The branding package name. The function returns this parameter in the typeshash.	A string value.	mobile
type	string	Whether the branding package is system-owned or user-owned. The function returns this parameter in the typeshash.	system yours	yours
pkgname	string	The branding package name.	A string value.	mobile
previewsmimg	string	The path to the branding package's preview image.	A file path.
selectopt	string	A parameter that always returns selected.	selected	selected
pkgchecked	string	Whether the account currently uses the branding package.	checked — The account uses the package. unchecked — The account does not use the package.	checked
previewimg	string	The path to the branding package's preview image.	A file path.
pkg	string	The branding package name.	A string value.	mobile
selected	boolean	A boolean value that is always 1	1	1
result	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories