Child pages
  • cPanel API 2 Functions - Branding::listobjecttypes

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function lists the current dynamicui.conf file's object types.

Include Page
LIB:_cPanelAPI2BrandingNote
LIB:_cPanelAPI2BrandingNote

Include Page
LIB:_cPanelAPI2NoEquivalent
LIB:_cPanelAPI2NoEquivalent

 

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleWHM API (JSON)
Code Block
languagetext
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Branding&cpanel_jsonapi_func=listobjecttypes

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink

Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List object types from the current dynamicui.conf file.
$list_dynamicui = $cpanel->api2(
    'Branding', 'listobjecttypes'
 );

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List object types from the current dynamicui.conf file.
my $list_dynamicui = $cpliveapi->api2(
    'Branding', 'listobjecttypes',
 );

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning

Expand
titleCommand Line
Code Block
languagebash
cpapi2 --user=username Branding listobjecttypes

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listobjecttypes",
    "data": [
      {
        "type": "css"
      },
      {
        "type": "html"
      },
      {
        "type": "image"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Branding"
  }
}

Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

 

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
typestringAn object type.

An object type in the current dynamicui.conf file.

image
resultBoolean

Whether the function succeeded.

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