Child pages
  • cPanel API 2 Functions - Branding::applist
Skip to end of metadata
Go to start of metadata

Description


Important:

 Ruby on Rails does not function on Amazon Linux servers.

This function lists icon information from the current dynamicui.conf file.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:


Note:

cPanel API 2's Branding module only modifies data for the x3 theme. To customize the Paper Lantern theme, use UAPI functions. For more information, read our Guide to cPanel Interface Customization and Branding documentation.

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


Note:

 For more information, read our Calls from the WHM API documentation.

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List items from the dynamicui.conf file.
$list_dynamicui_items = $cpanel->api2(
    'Branding', 'applist'
 );


Note:

For more information, read our Guide to the LiveAPI System.

 

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List items from the dynamicui.conf file.
my $list_dynamicui_items = $cpliveapi->api2(
    'Branding', 'applist',
 );


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Tag System (deprecated)


Warnings:

  • 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. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

 Command Line
cpapi2 --user=username Branding applist


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    /usr/local/cpanel/bin/cpapi2

 Output (JSON)
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "applist",
    "data": [
      {
        "group": "pref",
        "desc": "Preferences",
        "items": [
          {
            "width": "33",
            "itemorder": "1",
            "file": "getstart",
            "itemdesc": "Getting Started Wizard",
            "height": "32",
            "feature": "getstart",
            "subtype": "img",
            "group": "pref",
            "searchtext": "getting started wizard",
            "imgtype": "icon",
            "url": "getstarted/index.html",
            "type": "image"
          },
          {
            "width": "33",
            "itemorder": "2",
            "file": "tutorials",
            "itemdesc": "Video Tutorials",
            "height": "32",
            "feature": "videotut",
            "acontent": "target="_blank"",
            "subtype": "img",
            "group": "pref",
            "searchtext": "tutorials video",
            "imgtype": "icon",
            "url": "tutorial.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "3",
            "file": "password",
            "itemdesc": "Change Password",
            "height": "32",
            "feature": "password",
            "subtype": "img",
            "group": "pref",
            "searchtext": "password change",
            "imgtype": "icon",
            "url": "passwd/index.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "4",
            "file": "updatecontact",
            "itemdesc": "Update Contact Information",
            "height": "32",
            "feature": "updatecontact",
            "subtype": "img",
            "group": "pref",
            "searchtext": "email",
            "imgtype": "icon",
            "url": "contact/index.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "5",
            "file": "branding",
            "itemdesc": "Branding Editor",
            "height": "32",
            "if": "$isreseller",
            "subtype": "img",
            "group": "pref",
            "searchtext": "skin style theme",
            "imgtype": "icon",
            "url": "resellers/branding/index.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "6",
            "file": "lookandfeel",
            "itemdesc": "Change Style",
            "height": "32",
            "feature": "style",
            "subtype": "img",
            "group": "pref",
            "searchtext": "skin theme",
            "imgtype": "icon",
            "url": "style/index.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "7",
            "file": "changelang",
            "itemdesc": "Change Language",
            "height": "32",
            "feature": "setlang",
            "subtype": "img",
            "group": "pref",
            "searchtext": "language setlang",
            "imgtype": "icon",
            "url": "setlang/index.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "8",
            "file": "favorites",
            "itemdesc": "Shortcuts",
            "height": "32",
            "feature": "setlang",
            "subtype": "img",
            "group": "pref",
            "searchtext": "bookmarks",
            "imgtype": "icon",
            "url": "shortcuts/index.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "17",
            "file": "sec_policy",
            "itemdesc": "Security Policy",
            "height": "32",
            "if": "$CONF{'SecurityPolicy::SourceIPCheck'}",
            "subtype": "img",
            "group": "pref",
            "searchtext": "ip access questions login password security",
            "imgtype": "icon",
            "url": "security/index.html",
            "type": "image"
          }
        ]
      },
      {
        "group": "mail",
        "desc": "Mail",
        "items": [
          {
            "width": "32",
            "itemorder": "1",
            "file": "manageaccounts",
            "itemdesc": "Email Accounts",
            "height": "32",
            "feature": "popaccts",
            "subtype": "img",
            "group": "mail",
            "searchtext": "pop imap smtp new account",
            "imgtype": "icon",
            "url": "mail/pops.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "2",
            "file": "webemail",
            "itemdesc": "Webmail",
            "height": "32",
            "feature": "webmail",
            "subtype": "img",
            "group": "mail",
            "searchtext": "webmail",
            "imgtype": "icon",
            "url": "webmaillogin.html",
            "type": "image"
          },
          {
            "width": "35",
            "itemorder": "3",
            "file": "boxtrapper",
            "itemdesc": "BoxTrapper",
            "height": "32",
            "if": "!$CONF{'skipboxtrapper'} $CPDATA{'FEATURE-BOXTRAPPER'}",
            "feature": "boxtrapper",
            "subtype": "img",
            "group": "mail",
            "searchtext": "boxtrapper filter",
            "imgtype": "icon",
            "url": "mail/boxtrapper.html",
            "type": "image",
            "module": "BoxTrapper"
          },
          {
            "width": "46",
            "itemorder": "4",
            "file": "spamassassin",
            "itemdesc": "Apache SpamAssassinu2122",
            "height": "32",
            "if": "!$CONF{'skipspamassassin'} $CPDATA{'FEATURE-SPAMASSASSIN'}",
            "feature": "spamassassin",
            "subtype": "img",
            "group": "mail",
            "searchtext": "spamassassin apache spam email",
            "imgtype": "icon",
            "url": "mail/spam/spam.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "5",
            "file": "forwardersemail",
            "itemdesc": "Forwarders",
            "height": "32",
            "feature": "forwarders || emaildomainfwd",
            "subtype": "img",
            "group": "mail",
            "searchtext": "forwarders forward",
            "imgtype": "icon",
            "url": "mail/fwds.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "6",
            "file": "responder",
            "itemdesc": "Autoresponders",
            "height": "32",
            "feature": "autoresponders",
            "subtype": "img",
            "group": "mail",
            "searchtext": "autoresponder",
            "imgtype": "icon",
            "url": "mail/autores.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "7",
            "file": "defaultemailacct",
            "itemdesc": "Default Address",
            "height": "32",
            "feature": "defaultaddress",
            "subtype": "img",
            "group": "mail",
            "searchtext": "default address",
            "imgtype": "icon",
            "url": "mail/def.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "8",
            "file": "maillist",
            "itemdesc": "Mailing Lists",
            "height": "32",
            "if": "!$CONF{'skipmailman'}",
            "feature": "lists",
            "subtype": "img",
            "group": "mail",
            "searchtext": "mailman mailing lists",
            "imgtype": "icon",
            "url": "mail/lists.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "9",
            "file": "dfiltering",
            "itemdesc": "Account-Level Filtering",
            "height": "32",
            "feature": "blockers",
            "subtype": "img",
            "group": "mail",
            "searchtext": "account level filtered",
            "imgtype": "icon",
            "url": "mail/filters/userfilters.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "10",
            "file": "userfiltering",
            "itemdesc": "User-Level Filtering",
            "height": "32",
            "feature": "blockers",
            "subtype": "img",
            "group": "mail",
            "searchtext": "user level filtered",
            "imgtype": "icon",
            "url": "mail/filters/managefilters.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "11",
            "file": "email-reports",
            "itemdesc": "Email Trace",
            "height": "32",
            "feature": "emailtrace",
            "subtype": "img",
            "group": "mail",
            "searchtext": "email mail delivery report",
            "imgtype": "icon",
            "url": "mail/route.html",
            "type": "image",
            "module": "EmailTrack"
          },
          {
            "width": "35",
            "itemorder": "12",
            "file": "csvimport",
            "itemdesc": "Import Addresses and Forwarders",
            "height": "32",
            "feature": "csvimport",
            "subtype": "img",
            "group": "mail",
            "searchtext": "import mail csv xls",
            "imgtype": "icon",
            "url": "mail/csvimport.html",
            "type": "image",
            "module": "CSVImport"
          },
          {
            "width": "32",
            "itemorder": "13",
            "file": "emailauth",
            "itemdesc": "Email Authentication",
            "height": "32",
            "feature": "emailauth",
            "subtype": "img",
            "group": "mail",
            "searchtext": "spf domain-keys authentication dkim",
            "imgtype": "icon",
            "url": "mail/auth.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "14",
            "file": "emailmx",
            "itemdesc": "MX Entry",
            "height": "32",
            "feature": "changemx",
            "subtype": "img",
            "group": "mail",
            "searchtext": "entry mx dns",
            "imgtype": "icon",
            "url": "mail/mx.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "18",
            "file": "emailarch",
            "itemdesc": "Email Archiving",
            "height": "32",
            "if": "$CONF{'emailarchive'}",
            "feature": "emailarchive",
            "subtype": "img",
            "group": "mail",
            "searchtext": "email archive emailarch",
            "imgtype": "icon",
            "url": "mail/archive.html",
            "type": "image"
          }
        ]
      },
      {
        "group": "files",
        "desc": "Files",
        "items": [
          {
            "width": "32",
            "itemorder": "1",
            "file": "hd",
            "itemdesc": "Backups",
            "height": "32",
            "feature": "backup",
            "subtype": "img",
            "group": "files",
            "searchtext": "backup restore",
            "imgtype": "icon",
            "url": "backup/index.html",
            "type": "image"
          },
          {
            "width": "45",
            "itemorder": "2",
            "file": "backup-wizard",
            "itemdesc": "Backup Wizard",
            "height": "32",
            "feature": "backup",
            "subtype": "img",
            "group": "files",
            "searchtext": "backup wizard restore",
            "imgtype": "icon",
            "url": "backup/wizard.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "3",
            "file": "filemanager",
            "itemdesc": "File Manager",
            "height": "32",
            "feature": "filemanager",
            "acontent": "target="_blank"",
            "subtype": "img",
            "group": "files",
            "searchtext": "file manager file-manager",
            "imgtype": "icon",
            "url": "filemanager/index.html?showhidden=1&dir=/public_html",
            "onclick": "show_optionselect('filemanager'); return false;",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "4",
            "file": "legacy_filemanager",
            "itemdesc": "Legacy File Manager",
            "height": "32",
            "feature": "filemanager",
            "acontent": "target="_blank"",
            "subtype": "img",
            "group": "files",
            "searchtext": "file manager file-manager",
            "imgtype": "icon",
            "url": "files/index.html?showhidden=1&dir=/public_html",
            "onclick": "show_optionselect('files'); return false;",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "5",
            "file": "hdspace",
            "itemdesc": "Disk Space Usage",
            "height": "32",
            "feature": "diskusageviewer",
            "subtype": "img",
            "group": "files",
            "searchtext": "d space usage disk-usage",
            "imgtype": "icon",
            "url": "diskusage/index.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "6",
            "file": "webdav",
            "itemdesc": "Web Disk",
            "height": "32",
            "feature": "webdisk",
            "subtype": "img",
            "group": "files",
            "searchtext": "webdav webdisk web disk",
            "imgtype": "icon",
            "url": "webdav/accounts_webdav.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "7",
            "file": "ftpaccounts",
            "itemdesc": "FTP Accounts",
            "height": "32",
            "feature": "ftpaccts",
            "subtype": "img",
            "group": "files",
            "searchtext": "ftp create account",
            "imgtype": "icon",
            "url": "ftp/accounts.html",
            "touch": "ftp",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "8",
            "file": "ftpcontrol",
            "itemdesc": "FTP Session Control",
            "height": "32",
            "feature": "ftpaccts",
            "subtype": "img",
            "group": "files",
            "searchtext": "ftp session accounts",
            "imgtype": "icon",
            "url": "ftp/session.html",
            "touch": "ftp",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "9",
            "file": "anonymousmsg",
            "itemdesc": "Anonymous FTP",
            "height": "32",
            "if": "$hasanonftp",
            "feature": "ftpaccts",
            "subtype": "img",
            "group": "files",
            "searchtext": "anonymous ftp",
            "imgtype": "icon",
            "url": "ftp/anonymous.html",
            "touch": "ftp",
            "type": "image"
          }
        ]
      },
      {
        "group": "logs",
        "desc": "Logs",
        "items": [
          {
            "width": "32",
            "itemorder": "1",
            "file": "latestvisitors",
            "itemdesc": "Latest Visitors",
            "height": "32",
            "feature": "lastvisits",
            "subtype": "img",
            "group": "logs",
            "searchtext": "latest visitors",
            "imgtype": "icon",
            "url": "stats/lastvisitors_landing.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "2",
            "file": "networkmonitor",
            "itemdesc": "Bandwidth",
            "height": "32",
            "feature": "bandwidth",
            "subtype": "img",
            "group": "logs",
            "searchtext": "bandmin transfer",
            "imgtype": "icon",
            "url": "stats/bandwidth.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "4",
            "file": "webalizerlog",
            "itemdesc": "Webalizer",
            "height": "32",
            "if": "!$CONF{'skipwebalizer'} $CPDATA{'FEATURE-WEBALIZER'}",
            "feature": "webalizer",
            "subtype": "img",
            "group": "logs",
            "searchtext": "webalizer <abbr title="statistics">stats</abbr>",
            "imgtype": "icon",
            "url": "stats/webalizer_landing.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "5",
            "file": "webalizerftp",
            "itemdesc": "Webalizer FTP",
            "height": "32",
            "if": "!$CONF{'skipwebalizer'} $CPDATA{'FEATURE-WEBALIZER'}",
            "feature": "webalizer",
            "subtype": "img",
            "group": "logs",
            "searchtext": "webalizer <abbr title="statistics">stats</abbr> ftp",
            "imgtype": "icon",
            "url": "stats/webalizerftp_landing.html",
            "touch": "ftp",
            "type": "image"
          },
          {
            "_empty_": null,
            "width": "32",
            "itemorder": "6",
            "file": "rawaccesslogs",
            "itemdesc": "Raw Access Logs",
            "height": "32",
            "feature": "rawlog",
            "group": "logs",
            "subtype": "img",
            "searchtext": "rawlogs logs access",
            "imgtype": "icon",
            "url": "raw/index.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "7",
            "file": "analogstats",
            "itemdesc": "Analog Stats",
            "height": "32",
            "if": "!$CONF{'skipanalog'} $CPDATA{'FEATURE-ANALOG'}",
            "feature": "analog",
            "subtype": "img",
            "group": "logs",
            "searchtext": "analog <abbr title="statistics">stats</abbr>",
            "imgtype": "icon",
            "url": "stats/analog_landing.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "8",
            "file": "errorlogs",
            "itemdesc": "Error Log",
            "height": "32",
            "feature": "errlog",
            "subtype": "img",
            "group": "logs",
            "searchtext": "errorlog error_log error log",
            "imgtype": "icon",
            "url": "stats/errlog.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "9",
            "file": "chooselog",
            "itemdesc": "Choose Log Programs",
            "height": "32",
            "if": "$any_stats_enabled",
            "feature": "statselect",
            "subtype": "img",
            "group": "logs",
            "searchtext": "<abbr title="statistics">stats</abbr> manager",
            "imgtype": "icon",
            "url": "statmanager/index.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "20",
            "file": "awstats",
            "itemdesc": "AWStats",
            "height": "32",
            "if": "!$CONF{'skipawstats'} $CPDATA{'FEATURE-AWSTATS'}",
            "feature": "awstats",
            "subtype": "img",
            "group": "logs",
            "searchtext": "awstats",
            "imgtype": "icon",
            "url": "stats/awstats_landing.html",
            "type": "image"
          }
        ]
      },
      {
        "group": "sec",
        "desc": "Security",
        "items": [
          {
            "width": "32",
            "itemorder": "1",
            "file": "password-protect",
            "itemdesc": "Password Protect Directories",
            "height": "32",
            "feature": "webprotect",
            "subtype": "img",
            "group": "sec",
            "searchtext": "password protect protect password",
            "imgtype": "icon",
            "url": "htaccess/index.html",
            "onclick": "show_optionselect('password-protect'); return false;",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "2",
            "file": "ipdeny",
            "itemdesc": "IP Address Deny Manager",
            "height": "32",
            "feature": "ipdeny",
            "subtype": "img",
            "group": "sec",
            "searchtext": "deny block",
            "imgtype": "icon",
            "url": "denyip/index.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "3",
            "file": "ssl-manager",
            "itemdesc": "SSL/TLS Manager",
            "height": "32",
            "feature": "sslmanager",
            "subtype": "img",
            "group": "sec",
            "searchtext": "certificate key csr",
            "imgtype": "icon",
            "url": "ssl/index.html",
            "type": "image"
          },
          {
            "width": "37",
            "itemorder": "4",
            "file": "ssh-shell-access",
            "itemdesc": "SSH Shell Access",
            "height": "32",
            "feature": "ssh",
            "subtype": "img",
            "group": "sec",
            "searchtext": "ssh secure shell sftp",
            "imgtype": "icon",
            "url": "telnet/index.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "5",
            "file": "hotlinkprotect",
            "itemdesc": "HotLink Protection",
            "height": "32",
            "feature": "hotlink",
            "subtype": "img",
            "group": "sec",
            "searchtext": "protection",
            "imgtype": "icon",
            "url": "mime/hotlink.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "6",
            "file": "leechprotect",
            "itemdesc": "Leech Protect",
            "height": "32",
            "feature": "cpanelpro_leechprotect && webprotect",
            "subtype": "img",
            "group": "sec",
            "searchtext": "leech protect",
            "imgtype": "icon",
            "url": "htaccess/leechprotect/leechprotect.html",
            "onclick": "show_optionselect('leechprotect'); return false;",
            "type": "image",
            "module": "LeechProtect"
          },
          {
            "width": "32",
            "itemorder": "7",
            "file": "keys",
            "itemdesc": "GnuPG Keys",
            "height": "32",
            "feature": "pgp",
            "subtype": "img",
            "group": "sec",
            "searchtext": "gpg keys",
            "imgtype": "icon",
            "url": "gpg/index.html",
            "type": "image"
          }
        ]
      },
      {
        "group": "domains",
        "desc": "Domains",
        "items": [
          {
            "width": "43",
            "itemorder": "1",
            "file": "subdomains",
            "itemdesc": "Subdomains",
            "height": "32",
            "feature": "subdomains",
            "subtype": "img",
            "group": "domains",
            "searchtext": "domain",
            "imgtype": "icon",
            "url": "subdomain/index.html",
            "type": "image"
          },
          {
            "width": "33",
            "itemorder": "2",
            "file": "addondomain",
            "itemdesc": "Addon Domains",
            "height": "32",
            "feature": "addondomains",
            "subtype": "img",
            "group": "domains",
            "searchtext": "domain",
            "imgtype": "icon",
            "url": "addon/index.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "3",
            "file": "parkeddomains",
            "itemdesc": "Parked Domains",
            "height": "32",
            "feature": "parkeddomains",
            "subtype": "img",
            "group": "domains",
            "searchtext": "domain",
            "imgtype": "icon",
            "url": "park/index.html",
            "type": "image"
          },
          {
            "width": "33",
            "itemorder": "4",
            "file": "redirects",
            "itemdesc": "Redirects",
            "height": "32",
            "feature": "redirects",
            "subtype": "img",
            "group": "domains",
            "searchtext": "rewrite modrewrite",
            "imgtype": "icon",
            "url": "mime/redirect.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "10",
            "file": "simplezoneedit",
            "itemdesc": "Simple DNS Zone Editor",
            "height": "32",
            "feature": "simplezoneedit",
            "subtype": "img",
            "group": "domains",
            "searchtext": "DNS zone CNAME TTL",
            "imgtype": "icon",
            "url": "zoneedit/simple.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "11",
            "file": "zoneedit",
            "itemdesc": "Advanced DNS Zone Editor",
            "height": "32",
            "feature": "zoneedit",
            "subtype": "img",
            "group": "domains",
            "searchtext": "DNS zone CNAME TTL",
            "imgtype": "icon",
            "url": "zoneedit/advanced.html",
            "type": "image"
          }
        ]
      },
      {
        "group": "db",
        "desc": "Databases",
        "items": [
          {
            "width": "45",
            "itemorder": "1",
            "file": "mysql",
            "itemdesc": "MySQL Databases",
            "height": "31",
            "feature": "mysql",
            "subtype": "img",
            "group": "db",
            "searchtext": "mysql database",
            "imgtype": "icon",
            "url": "sql/index.html",
            "type": "image"
          },
          {
            "width": "45",
            "itemorder": "2",
            "file": "mysql-wizard3",
            "itemdesc": "MySQL Database Wizard",
            "height": "31",
            "feature": "mysql",
            "subtype": "img",
            "group": "db",
            "searchtext": "mysql database",
            "imgtype": "icon",
            "url": "sql/wizard1.html",
            "type": "image"
          },
          {
            "width": "45",
            "itemorder": "3",
            "file": "phpMyAdmin",
            "itemdesc": "phpMyAdmin",
            "height": "34",
            "feature": "phpmyadmin",
            "acontent": "target="_blank"",
            "subtype": "img",
            "group": "db",
            "searchtext": "mysql database",
            "imgtype": "icon",
            "url": "sql/PhpMyAdmin.html",
            "type": "image"
          },
          {
            "width": "45",
            "itemorder": "4",
            "file": "mysql-remoteaccess",
            "itemdesc": "Remote MySQL",
            "height": "31",
            "feature": "mysql",
            "subtype": "img",
            "group": "db",
            "searchtext": "remote mysql",
            "imgtype": "icon",
            "url": "sql/managehost.html",
            "type": "image"
          }
        ]
      },
      {
        "group": "software",
        "desc": "Software and Services",
        "items": [
          {
            "width": "32",
            "itemorder": "1",
            "file": "cgi-center",
            "itemdesc": "CGI Center",
            "height": "32",
            "feature": "cgi",
            "subtype": "img",
            "group": "software",
            "searchtext": "cgi",
            "imgtype": "icon",
            "url": "cgi/index.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "2",
            "file": "scripts-library",
            "itemdesc": "Site Software",
            "height": "32",
            "feature": "addoncgi",
            "subtype": "img",
            "group": "software",
            "searchtext": "addons software",
            "imgtype": "icon",
            "url": "addoncgi/cpaddons.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "4",
            "file": "perl",
            "itemdesc": "Perl Modules",
            "height": "32",
            "if": "$hasperl",
            "feature": "modules-perl",
            "subtype": "img",
            "group": "software",
            "searchtext": "module perl",
            "imgtype": "icon",
            "url": "module_installers/index.html?lang=perl",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "5",
            "file": "php-pear",
            "itemdesc": "PHP PEAR Packages",
            "height": "32",
            "if": "$haspear",
            "feature": "modules-php-pear",
            "subtype": "img",
            "group": "software",
            "searchtext": "php pear packages",
            "imgtype": "icon",
            "url": "module_installers/index.html?lang=php-pear",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "6",
            "file": "php",
            "itemdesc": "PHP Configuration",
            "height": "32",
            "feature": "php-config",
            "subtype": "img",
            "group": "software",
            "searchtext": "config configuration",
            "imgtype": "icon",
            "url": "php/index.html?lang",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "7",
            "file": "ruby",
            "itemdesc": "RubyGems",
            "height": "32",
            "if": "$hasgem",
            "feature": "modules-ruby",
            "subtype": "img",
            "group": "software",
            "searchtext": "ror ruby rails gems",
            "imgtype": "icon",
            "url": "module_installers/index.html?lang=ruby",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "8",
            "file": "rails",
            "itemdesc": "Ruby on Rails",
            "height": "32",
            "if": "$hasrails",
            "feature": "ror",
            "subtype": "img",
            "group": "software",
            "searchtext": "ruby rails gems",
            "imgtype": "icon",
            "url": "ror/index.html",
            "type": "image",
            "module": "RoR"
          }
        ]
      },
      {
        "group": "advanced",
        "desc": "Advanced",
        "items": [
          {
            "width": "45",
            "itemorder": "1",
            "file": "apache",
            "itemdesc": "Apache Handlers",
            "height": "30",
            "feature": "handlers",
            "subtype": "img",
            "group": "advanced",
            "searchtext": "apache handlers extension configure",
            "imgtype": "icon",
            "url": "mime/handle.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "4",
            "file": "image-manager",
            "itemdesc": "Image Manager",
            "height": "32",
            "feature": "cpanelpro_images",
            "subtype": "img",
            "group": "advanced",
            "searchtext": "image resize manager scaler thumbnailer format",
            "imgtype": "icon",
            "url": "cpanelpro/images.html",
            "type": "image",
            "module": "ImageManager"
          },
          {
            "width": "32",
            "itemorder": "5",
            "file": "index",
            "itemdesc": "Index Manager",
            "height": "32",
            "feature": "indexmanager",
            "subtype": "img",
            "group": "advanced",
            "searchtext": "index manager",
            "imgtype": "icon",
            "url": "indexmanager/index.html",
            "onclick": "show_optionselect('index'); return false;",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "6",
            "file": "errorpage",
            "itemdesc": "Error Pages",
            "height": "32",
            "feature": "errpgs",
            "subtype": "img",
            "group": "advanced",
            "searchtext": "errorlog error_log error log",
            "imgtype": "icon",
            "url": "err/index.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "7",
            "file": "cron",
            "itemdesc": "Cron Jobs",
            "height": "32",
            "feature": "cron",
            "subtype": "img",
            "group": "advanced",
            "searchtext": "cronjob cron job tab edit",
            "imgtype": "icon",
            "url": "cron/index.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "8",
            "file": "nettools",
            "itemdesc": "Network Tools",
            "height": "32",
            "feature": "nettools",
            "subtype": "img",
            "group": "advanced",
            "searchtext": "traceroute tracert dns lookup dig",
            "imgtype": "icon",
            "url": "net/index.html",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "12",
            "file": "mime-types",
            "itemdesc": "MIME Types",
            "height": "32",
            "feature": "mime",
            "subtype": "img",
            "group": "advanced",
            "searchtext": "mime mimetype types",
            "imgtype": "icon",
            "url": "mime/mime.html",
            "type": "image"
          },
          {
            "width": "45",
            "itemorder": "13",
            "file": "whm",
            "itemdesc": "WebHost Manager",
            "height": "32",
            "if": "$isreseller",
            "subtype": "img",
            "group": "advanced",
            "searchtext": "webhostmanager whm",
            "imgtype": "icon",
            "url": "/cpsess1176970725/xferwhm/",
            "type": "image"
          },
          {
            "width": "32",
            "itemorder": "14",
            "file": "cpanelAPI",
            "height": "32",
            "itemdesc": "<abbr title="Application Programming Interface" class="initialism">API</abbr> Shell",
            "if": "$CONF{'api_shell'} && $isreseller",
            "feature": "api_shell",
            "group": "advanced",
            "subtype": "img",
            "imgtype": "icon",
            "url": "api_shell/index.html",
            "type": "image"
          }
        ]
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Branding"
  }
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

 

Parameters

InputTypeDescriptionPossible valuesExample
nvargliststring

The order in which to return data.

A list of UI groups.

Separate multiple group names with the pipe character (|).

mail|file|domains|logs

Returns


Note:

On servers that run CentOS 7, you may see a named warning about the absence of SPF resource records on DNS.

  • This warning is not relevant on CentOS 7 servers, because RFC 7208 deprecated SPF records. CentOS 7 servers use TXT records instead of SPF records.
  • Red Hat 7.1 and CentOS 7.1 both contain bind-9.9.4-23.el7, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the Red Hat Bugzilla case about SPF record errors.

ReturnTypeDescriptionPossible valuesExample
groupstringThe UI group's name.A string value.pref
descstringThe UI group's display name.A string value.Preferences
itemshashA hash of information about the group's items.This hash includes the width, itemorder, file, itemdesc, height, if, feature, subtype, group, searchtext, imgtype, url, and type returns. 

width

integer

The item's icon's width.

The function returns this value in the items hash.

An integer that represents an image's width, in pixels.33

itemorder

integer

The item's display order.

The function returns this value in the items hash.

An integer that represents the item's display order.

For example, groups display the item that has an itemorder value of 1 first.

1

file

string

The item's icon filename.

The function returns this value in the items hash.

An image's filename.

Note:

This image must exist in the /usr/local/cpanel/base/frontend/theme/branding/ directory, where theme represents the current branding theme. 

getstart

itemdesc

string

The item's display name.

The function returns this value in the items hash.

A string value.

 

Getting Started Wizard

height

integer

The item's icon's height.

The function returns this value in the items hash.

An integer that represents an image's height, in pixels.32

if

string

Conditional arguments that determine whether to display the item, if any exist.

The function returns this value in the items hash.

Conditional arguments that determine whether to display the item.

For example, $isreseller indicates that the item only displays for reseller accounts.

For more information, read our Guide to cPanel Variables documentation.

$isreseller

feature

string

A feature name. The item will only display if the cPanel user has access to this feature.

The function returns this value in the items hash.

A feature name.getstart

subtype

string

The item's subtype.

The function returns this value in the items hash.

img is the only possible value.img

group

string

The item's group.

The function returns this value in the items hash.

A string value.pref

searchtext

string

One or more search terms. The item will display when users enter these search terms in the Quick Find text box.

The function returns this value in the items hash.

A space-separated list of search terms.getting started wizard

imgtype

string

The item's image type.

The function returns this value in the items hash.

icon is the only possible value.icon

url

string

The location to which the item's icon links.

The function returns this value in the items hash.

A valid file path or URL.
getstarted/index.html

type

string

The item's type.

The function returns this value in the items hash.

image is the only possible value.image
resultBoolean

Whether the function succeeded.

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