Description

This function updates objects in a branding package's dynamicui.conf file.

 

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=brandingeditor&type="image"&imgtype="icon"&showdeleted="1"

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Update the dynamicui.conf file.
$update_dynamicui = $cpanel->api2(
    'Branding', 'brandingeditor',
		array(        
			'type'           => 'image',
            'imgtype'        => 'icon',
            'showdeleted'    => '1',
    ) 
 );

 

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Update the dynamicui.conf file.
my $update_dynamicui = $cpliveapi->api2(
    'Branding', 'brandingeditor',
    { 
			'type'           => 'image',
            'imgtype'        => 'icon',
            'showdeleted'    => '1',
	}
 );

 

cpapi2 --user=username Branding brandingeditor type=image imgtype=icon showdeleted=1

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "brandingeditor",
    "data": [
      {
        "width": "33",
        "number": 1,
        "file": "addondomain",
        "subtype": "img",
        "group": "domains",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/addondomain.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Addon Domains",
        "height": "32",
        "htmldescription": "Addon Domains",
        "type": "image"
      },
      {
        "width": "32",
        "number": 2,
        "file": "analogstats",
        "subtype": "img",
        "group": "logs",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/analogstats.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Analog Stats",
        "height": "32",
        "htmldescription": "Analog Stats",
        "type": "image"
      },
      {
        "width": "32",
        "number": 3,
        "file": "anonymousmsg",
        "subtype": "img",
        "group": "files",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/anonymousmsg.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Anonymous FTP Message",
        "height": "32",
        "htmldescription": "Anonymous FTP Message",
        "type": "image"
      },
      {
        "width": "45",
        "number": 4,
        "file": "apache",
        "subtype": "img",
        "group": "advanced",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/apache.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Apache Handlers",
        "height": "30",
        "htmldescription": "Apache Handlers",
        "type": "image"
      },
      {
        "width": "32",
        "number": 5,
        "file": "awstats",
        "subtype": "img",
        "group": "logs",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/awstats.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "AWStats",
        "height": "32",
        "htmldescription": "AWStats",
        "type": "image"
      },
      {
        "width": "45",
        "number": 6,
        "file": "backup-wizard",
        "subtype": "img",
        "group": "files",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/backup-wizard.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Backup Wizard",
        "height": "32",
        "htmldescription": "Backup Wizard",
        "type": "image"
      },
      {
        "width": "35",
        "number": 7,
        "file": "boxtrapper",
        "subtype": "img",
        "group": "mail",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/boxtrapper.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "BoxTrapper",
        "height": "32",
        "htmldescription": "BoxTrapper",
        "type": "image"
      },
      {
        "width": "32",
        "number": 8,
        "file": "branding",
        "subtype": "img",
        "group": "pref",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/branding.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Branding Editor",
        "height": "32",
        "htmldescription": "Branding Editor",
        "type": "image"
      },
      {
        "width": "32",
        "number": 9,
        "file": "cgi-center",
        "subtype": "img",
        "group": "software",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/cgi-center.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "CGI Center",
        "height": "32",
        "htmldescription": "CGI Center",
        "type": "image"
      },
      {
        "width": "32",
        "number": 10,
        "file": "changelang",
        "subtype": "img",
        "group": "pref",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/changelang.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Change Language",
        "height": "32",
        "htmldescription": "Change Language",
        "type": "image"
      },
      {
        "width": "32",
        "number": 11,
        "file": "chooselog",
        "subtype": "img",
        "group": "logs",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/chooselog.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Choose Log Programs",
        "height": "32",
        "htmldescription": "Choose Log Programs",
        "type": "image"
      },
      {
        "width": "32",
        "number": 12,
        "file": "clam",
        "subtype": "img",
        "group": "advanced",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/clam.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Virus Scanner",
        "height": "32",
        "htmldescription": "Virus Scanner",
        "type": "image"
      },
      {
        "width": "32",
        "number": 13,
        "file": "cpanelAPI",
        "subtype": "img",
        "group": "advanced",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1389286071/frontend/x3/branding/cpanelAPI.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "cPanel <abbr title="Application Programming Interface" class="initialism">API</abbr> Shell",
        "height": "32",
        "htmldescription": "cPanel <abbr title="Application Programming Interface" class="initialism">API</abbr> Shell",
        "type": "image"
      },
      {
        "width": "32",
        "number": 14,
        "file": "cron",
        "subtype": "img",
        "group": "advanced",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/cron.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Cron Jobs",
        "height": "32",
        "htmldescription": "Cron Jobs",
        "type": "image"
      },
      {
        "width": "35",
        "number": 15,
        "file": "csvimport",
        "subtype": "img",
        "group": "mail",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/csvimport.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Import Addresses and Forwarders",
        "height": "32",
        "htmldescription": "Import Addresses and Forwarders",
        "type": "image"
      },
      {
        "width": "32",
        "number": 16,
        "file": "defaultemailacct",
        "subtype": "img",
        "group": "mail",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/defaultemailacct.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Default Address",
        "height": "32",
        "htmldescription": "Default Address",
        "type": "image"
      },
      {
        "width": "32",
        "number": 17,
        "file": "dfiltering",
        "subtype": "img",
        "group": "mail",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/dfiltering.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Account-Level Filtering",
        "height": "32",
        "htmldescription": "Account-Level Filtering",
        "type": "image"
      },
      {
        "width": "32",
        "number": 18,
        "file": "email-reports",
        "subtype": "img",
        "group": "mail",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1370377685/frontend/x3/branding/email-reports.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Email Trace",
        "height": "32",
        "htmldescription": "Email Trace",
        "type": "image"
      },
      {
        "width": "32",
        "number": 19,
        "file": "emailarch",
        "subtype": "img",
        "group": "mail",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1370531486/frontend/x3/branding/emailarch.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Email Archiving",
        "height": "32",
        "htmldescription": "Email Archiving",
        "type": "image"
      },
      {
        "width": "32",
        "number": 20,
        "file": "emailauth",
        "subtype": "img",
        "group": "mail",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/emailauth.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Email Authentication",
        "height": "32",
        "htmldescription": "Email Authentication",
        "type": "image"
      },
      {
        "width": "32",
        "number": 21,
        "file": "emailmx",
        "subtype": "img",
        "group": "mail",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/emailmx.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "MX Entry",
        "height": "32",
        "htmldescription": "MX Entry",
        "type": "image"
      },
      {
        "width": "32",
        "number": 22,
        "file": "enduserlve",
        "subtype": "img",
        "group": "logs",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/enduserlve.png",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "CPU and Concurrent Connection Usage",
        "height": "32",
        "htmldescription": "CPU and Concurrent Connection Usage",
        "type": "image"
      },
      {
        "width": "32",
        "number": 23,
        "file": "errorlogs",
        "subtype": "img",
        "group": "logs",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/errorlogs.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Error Log",
        "height": "32",
        "htmldescription": "Error Log",
        "type": "image"
      },
      {
        "width": "32",
        "number": 24,
        "file": "errorpage",
        "subtype": "img",
        "group": "advanced",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/errorpage.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Error Pages",
        "height": "32",
        "htmldescription": "Error Pages",
        "type": "image"
      },
      {
        "width": "32",
        "number": 25,
        "file": "favorites",
        "subtype": "img",
        "group": "pref",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/favorites.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Shortcuts",
        "height": "32",
        "htmldescription": "Shortcuts",
        "type": "image"
      },
      {
        "width": "32",
        "number": 26,
        "file": "filemanager",
        "subtype": "img",
        "group": "files",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/filemanager.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "File Manager",
        "height": "32",
        "htmldescription": "File Manager",
        "type": "image"
      },
      {
        "width": "32",
        "number": 27,
        "file": "forwardersemail",
        "subtype": "img",
        "group": "mail",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/forwardersemail.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Forwarders",
        "height": "32",
        "htmldescription": "Forwarders",
        "type": "image"
      },
      {
        "width": "32",
        "number": 28,
        "file": "ftpaccounts",
        "subtype": "img",
        "group": "files",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/ftpaccounts.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "FTP Accounts",
        "height": "32",
        "htmldescription": "FTP Accounts",
        "type": "image"
      },
      {
        "width": "32",
        "number": 29,
        "file": "ftpcontrol",
        "subtype": "img",
        "group": "files",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/ftpcontrol.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "FTP Session Control",
        "height": "32",
        "htmldescription": "FTP Session Control",
        "type": "image"
      },
      {
        "width": "33",
        "number": 30,
        "file": "getstart",
        "subtype": "img",
        "group": "pref",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/getstart.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Getting Started Wizard",
        "height": "32",
        "htmldescription": "Getting Started Wizard",
        "type": "image"
      },
      {
        "width": "32",
        "number": 31,
        "file": "group_advanced",
        "subtype": "img",
        "group": "advanced",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/group_advanced.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Advanced",
        "height": "32",
        "htmldescription": "Advanced",
        "type": "image"
      },
      {
        "width": "32",
        "number": 32,
        "file": "group_db",
        "subtype": "img",
        "group": "db",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/group_db.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Databases",
        "height": "32",
        "htmldescription": "Databases",
        "type": "image"
      },
      {
        "width": "32",
        "number": 33,
        "file": "group_domains",
        "subtype": "img",
        "group": "domains",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/group_domains.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Domains",
        "height": "32",
        "htmldescription": "Domains",
        "type": "image"
      },
      {
        "width": "32",
        "number": 34,
        "file": "group_files",
        "subtype": "img",
        "group": "files",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/group_files.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Files",
        "height": "32",
        "htmldescription": "Files",
        "type": "image"
      },
      {
        "width": "32",
        "number": 35,
        "file": "group_logs",
        "subtype": "img",
        "group": "logs",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/group_logs.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Logs",
        "height": "32",
        "htmldescription": "Logs",
        "type": "image"
      },
      {
        "width": "32",
        "number": 36,
        "file": "group_mail",
        "subtype": "img",
        "group": "mail",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/group_mail.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Mail",
        "height": "32",
        "htmldescription": "Mail",
        "type": "image"
      },
      {
        "width": "32",
        "number": 37,
        "file": "group_pref",
        "subtype": "img",
        "group": "pref",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/group_pref.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Preferences",
        "height": "32",
        "htmldescription": "Preferences",
        "type": "image"
      },
      {
        "width": "32",
        "number": 38,
        "file": "group_sec",
        "subtype": "img",
        "group": "sec",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/group_sec.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Security",
        "height": "32",
        "htmldescription": "Security",
        "type": "image"
      },
      {
        "width": "32",
        "number": 39,
        "file": "group_software",
        "subtype": "img",
        "group": "software",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/group_software.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Software and Services",
        "height": "32",
        "htmldescription": "Software and Services",
        "type": "image"
      },
      {
        "width": "32",
        "number": 40,
        "file": "hd",
        "subtype": "img",
        "group": "files",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/hd.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Backups",
        "height": "32",
        "htmldescription": "Backups",
        "type": "image"
      },
      {
        "width": "32",
        "number": 41,
        "file": "hdspace",
        "subtype": "img",
        "group": "files",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/hdspace.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Disk Space Usage",
        "height": "32",
        "htmldescription": "Disk Space Usage",
        "type": "image"
      },
      {
        "width": "32",
        "number": 42,
        "file": "hotlinkprotect",
        "subtype": "img",
        "group": "sec",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/hotlinkprotect.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Hotlink Protection",
        "height": "32",
        "htmldescription": "Hotlink Protection",
        "type": "image"
      },
      {
        "width": "32",
        "number": 43,
        "file": "image-manager",
        "subtype": "img",
        "group": "advanced",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/image-manager.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Image Manager",
        "height": "32",
        "htmldescription": "Image Manager",
        "type": "image"
      },
      {
        "width": "32",
        "number": 44,
        "file": "index",
        "subtype": "img",
        "group": "advanced",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/index.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Index Manager",
        "height": "32",
        "htmldescription": "Index Manager",
        "type": "image"
      },
      {
        "width": "32",
        "number": 45,
        "file": "ipdeny",
        "subtype": "img",
        "group": "sec",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/ipdeny.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "IP Address Deny Manager",
        "height": "32",
        "htmldescription": "IP Address Deny Manager",
        "type": "image"
      },
      {
        "width": "32",
        "number": 46,
        "file": "keys",
        "subtype": "img",
        "group": "sec",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/keys.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "GnuPG Keys",
        "height": "32",
        "htmldescription": "GnuPG Keys",
        "type": "image"
      },
      {
        "width": "32",
        "number": 47,
        "file": "latestvisitors",
        "subtype": "img",
        "group": "logs",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/latestvisitors.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Latest Visitors",
        "height": "32",
        "htmldescription": "Latest Visitors",
        "type": "image"
      },
      {
        "width": "32",
        "number": 48,
        "file": "leechprotect",
        "subtype": "img",
        "group": "sec",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/leechprotect.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Leech Protect",
        "height": "32",
        "htmldescription": "Leech Protect",
        "type": "image"
      },
      {
        "width": "32",
        "number": 49,
        "file": "legacy_filemanager",
        "subtype": "img",
        "group": "files",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/legacy_filemanager.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Legacy File Manager",
        "height": "32",
        "htmldescription": "Legacy File Manager",
        "type": "image"
      },
      {
        "width": "32",
        "number": 51,
        "file": "lookandfeel",
        "subtype": "img",
        "group": "pref",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/lookandfeel.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Change Style",
        "height": "32",
        "htmldescription": "Change Style",
        "type": "image"
      },
      {
        "width": "32",
        "number": 52,
        "file": "maillist",
        "subtype": "img",
        "group": "mail",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/maillist.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Mailing Lists",
        "height": "32",
        "htmldescription": "Mailing Lists",
        "type": "image"
      },
      {
        "width": "32",
        "number": 53,
        "file": "manageaccounts",
        "subtype": "img",
        "group": "mail",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/manageaccounts.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Email Accounts",
        "height": "32",
        "htmldescription": "Email Accounts",
        "type": "image"
      },
      {
        "width": "32",
        "number": 54,
        "file": "mime-types",
        "subtype": "img",
        "group": "advanced",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/mime-types.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "<abbr title="Multipurpose Internet Mail Extensions" class="initialism">MIME</abbr> Types",
        "height": "32",
        "htmldescription": "<abbr title="Multipurpose Internet Mail Extensions" class="initialism">MIME</abbr> Types",
        "type": "image"
      },
      {
        "width": "48",
        "number": 55,
        "file": "mod_security",
        "subtype": "img",
        "group": "sec",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1409077276/frontend/x3/branding/mod_security.png",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "ModSecurity",
        "height": "48",
        "htmldescription": "ModSecurity",
        "type": "image"
      },
      {
        "width": "45",
        "number": 56,
        "file": "mysql",
        "subtype": "img",
        "group": "db",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/mysql.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "MySQLu00ae Databases",
        "height": "31",
        "htmldescription": "MySQLu00ae Databases",
        "type": "image"
      },
      {
        "width": "45",
        "number": 57,
        "file": "mysql-remoteaccess",
        "subtype": "img",
        "group": "db",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/mysql-remoteaccess.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Remote MySQL",
        "height": "31",
        "htmldescription": "Remote MySQL",
        "type": "image"
      },
      {
        "width": "45",
        "number": 58,
        "file": "mysql-wizard3",
        "subtype": "img",
        "group": "db",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/mysql-wizard3.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "MySQL Database Wizard",
        "height": "31",
        "htmldescription": "MySQL Database Wizard",
        "type": "image"
      },
      {
        "width": "32",
        "number": 59,
        "file": "nettools",
        "subtype": "img",
        "group": "advanced",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/nettools.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Network Tools",
        "height": "32",
        "htmldescription": "Network Tools",
        "type": "image"
      },
      {
        "width": "32",
        "number": 60,
        "file": "networkmonitor",
        "subtype": "img",
        "group": "logs",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/networkmonitor.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Bandwidth",
        "height": "32",
        "htmldescription": "Bandwidth",
        "type": "image"
      },
      {
        "width": "45",
        "number": 61,
        "file": "optimizews",
        "subtype": "img",
        "group": "software",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/optimizews.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Optimize Website",
        "height": "32",
        "htmldescription": "Optimize Website",
        "type": "image"
      },
      {
        "width": "32",
        "number": 62,
        "file": "parkeddomains",
        "subtype": "img",
        "group": "domains",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/parkeddomains.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Parked Domains",
        "height": "32",
        "htmldescription": "Parked Domains",
        "type": "image"
      },
      {
        "width": "32",
        "number": 63,
        "file": "password",
        "subtype": "img",
        "group": "pref",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/password.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Change Password",
        "height": "32",
        "htmldescription": "Change Password",
        "type": "image"
      },
      {
        "width": "32",
        "number": 64,
        "file": "password-protect",
        "subtype": "img",
        "group": "sec",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/password-protect.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Password Protect Directories",
        "height": "32",
        "htmldescription": "Password Protect Directories",
        "type": "image"
      },
      {
        "width": "32",
        "number": 65,
        "file": "perl",
        "subtype": "img",
        "group": "software",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/perl.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Perl Modules",
        "height": "32",
        "htmldescription": "Perl Modules",
        "type": "image"
      },
      {
        "width": "32",
        "number": 66,
        "file": "php",
        "subtype": "img",
        "group": "software",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/php.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "PHP Configuration",
        "height": "32",
        "htmldescription": "PHP Configuration",
        "type": "image"
      },
      {
        "width": "32",
        "number": 67,
        "file": "php-pear",
        "subtype": "img",
        "group": "software",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/php-pear.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "PHP PEAR Packages",
        "height": "32",
        "htmldescription": "PHP PEAR Packages",
        "type": "image"
      },
      {
        "width": "45",
        "number": 68,
        "file": "phpMyAdmin",
        "subtype": "img",
        "group": "db",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/phpMyAdmin.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "phpMyAdmin",
        "height": "34",
        "htmldescription": "phpMyAdmin",
        "type": "image"
      },
      {
        "width": "50",
        "number": 69,
        "file": "phpPgAdmin",
        "subtype": "img",
        "group": "db",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/phpPgAdmin.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "phpPgAdmin",
        "height": "32",
        "htmldescription": "phpPgAdmin",
        "type": "image"
      },
      {
        "width": "32",
        "number": 70,
        "file": "postgresql",
        "subtype": "img",
        "group": "db",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/postgresql.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "PostgreSQL Databases",
        "height": "32",
        "htmldescription": "PostgreSQL Databases",
        "type": "image"
      },
      {
        "width": "45",
        "number": 71,
        "file": "postgresql-wizard",
        "subtype": "img",
        "group": "db",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/postgresql-wizard.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "PostgreSQL Database Wizard",
        "height": "31",
        "htmldescription": "PostgreSQL Database Wizard",
        "type": "image"
      },
      {
        "width": "32",
        "number": 72,
        "file": "rails",
        "subtype": "img",
        "group": "software",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/rails.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Ruby on Rails",
        "height": "32",
        "htmldescription": "Ruby on Rails",
        "type": "image"
      },
      {
        "width": "32",
        "number": 73,
        "file": "rawaccesslogs",
        "subtype": "img",
        "group": "logs",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/rawaccesslogs.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Raw Access Logs",
        "height": "32",
        "htmldescription": "Raw Access Logs",
        "type": "image"
      },
      {
        "width": "33",
        "number": 74,
        "file": "redirects",
        "subtype": "img",
        "group": "domains",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/redirects.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Redirects",
        "height": "32",
        "htmldescription": "Redirects",
        "type": "image"
      },
      {
        "width": "32",
        "number": 75,
        "file": "responder",
        "subtype": "img",
        "group": "mail",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/responder.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Autoresponders",
        "height": "32",
        "htmldescription": "Autoresponders",
        "type": "image"
      },
      {
        "width": "32",
        "number": 76,
        "file": "ruby",
        "subtype": "img",
        "group": "software",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/ruby.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "RubyGems",
        "height": "32",
        "htmldescription": "RubyGems",
        "type": "image"
      },
      {
        "width": "32",
        "number": 77,
        "file": "scripts-library",
        "subtype": "img",
        "group": "software",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/scripts-library.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Site Software",
        "height": "32",
        "htmldescription": "Site Software",
        "type": "image"
      },
      {
        "width": "32",
        "number": 78,
        "file": "sec_policy",
        "subtype": "img",
        "group": "pref",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/sec_policy.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Security Policy",
        "height": "32",
        "htmldescription": "Security Policy",
        "type": "image"
      },
      {
        "width": "32",
        "number": 79,
        "file": "simplezoneedit",
        "subtype": "img",
        "group": "domains",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/simplezoneedit.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Simple DNS Zone Editor",
        "height": "32",
        "htmldescription": "Simple DNS Zone Editor",
        "type": "image"
      },
      {
        "width": "46",
        "number": 80,
        "file": "spamassassin",
        "subtype": "img",
        "group": "mail",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1412794718/frontend/x3/branding/spamassassin.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Apache SpamAssassinu2122",
        "height": "32",
        "htmldescription": "Apache SpamAssassinu2122",
        "type": "image"
      },
      {
        "width": "37",
        "number": 81,
        "file": "ssh-shell-access",
        "subtype": "img",
        "group": "sec",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/ssh-shell-access.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "SSH Shell Access",
        "height": "32",
        "htmldescription": "SSH Shell Access",
        "type": "image"
      },
      {
        "width": "32",
        "number": 82,
        "file": "ssl-manager",
        "subtype": "img",
        "group": "sec",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/ssl-manager.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "SSL/TLS Manager",
        "height": "32",
        "htmldescription": "SSL/TLS Manager",
        "type": "image"
      },
      {
        "width": "43",
        "number": 83,
        "file": "subdomains",
        "subtype": "img",
        "group": "domains",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/subdomains.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Subdomains",
        "height": "32",
        "htmldescription": "Subdomains",
        "type": "image"
      },
      {
        "width": "32",
        "number": 84,
        "file": "submit-support",
        "subtype": "img",
        "group": "advanced",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/submit-support.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Submit a Support Request",
        "height": "32",
        "htmldescription": "Submit a Support Request",
        "type": "image"
      },
      {
        "width": "33",
        "number": 85,
        "file": "tutorials",
        "subtype": "img",
        "group": "pref",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/tutorials.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Video Tutorials",
        "height": "32",
        "htmldescription": "Video Tutorials",
        "type": "image"
      },
      {
        "width": "32",
        "number": 86,
        "file": "updatecontact",
        "subtype": "img",
        "group": "pref",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/updatecontact.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Update Contact Information",
        "height": "32",
        "htmldescription": "Update Contact Information",
        "type": "image"
      },
      {
        "width": "43",
        "number": 87,
        "file": "urchin",
        "subtype": "img",
        "group": "logs",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/urchin.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Urchin Stats",
        "height": "32",
        "htmldescription": "Urchin Stats",
        "type": "image"
      },
      {
        "width": "32",
        "number": 88,
        "file": "userfiltering",
        "subtype": "img",
        "group": "mail",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/userfiltering.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "User-Level Filtering",
        "height": "32",
        "htmldescription": "User-Level Filtering",
        "type": "image"
      },
      {
        "width": "32",
        "number": 89,
        "file": "webalizerftp",
        "subtype": "img",
        "group": "logs",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/webalizerftp.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Webalizer FTP",
        "height": "32",
        "htmldescription": "Webalizer FTP",
        "type": "image"
      },
      {
        "width": "32",
        "number": 90,
        "file": "webalizerlog",
        "subtype": "img",
        "group": "logs",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/webalizerlog.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Webalizer",
        "height": "32",
        "htmldescription": "Webalizer",
        "type": "image"
      },
      {
        "width": "32",
        "number": 91,
        "file": "webdav",
        "subtype": "img",
        "group": "files",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/webdav.jpg",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Web Disk",
        "height": "32",
        "htmldescription": "Web Disk",
        "type": "image"
      },
      {
        "width": "32",
        "number": 92,
        "file": "webemail",
        "subtype": "img",
        "group": "mail",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/webemail.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Webmail",
        "height": "32",
        "htmldescription": "Webmail",
        "type": "image"
      },
      {
        "width": "45",
        "number": 93,
        "file": "whm",
        "subtype": "img",
        "group": "advanced",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/whm.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "WebHost Manager",
        "height": "32",
        "htmldescription": "WebHost Manager",
        "type": "image"
      },
      {
        "width": "32",
        "number": 94,
        "file": "zoneedit",
        "subtype": "img",
        "group": "domains",
        "imgtype": "icon",
        "url": "/cPanel_magic_revision_1327526145/frontend/x3/branding/zoneedit.gif",
        "reqext": null,
        "global": null,
        "requiredtxt": "Requires",
        "origin": "x3 (System)",
        "deleted": 0,
        "description": "Advanced DNS Zone Editor",
        "height": "32",
        "htmldescription": "Advanced DNS Zone Editor",
        "type": "image"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Branding"
  }
}

 

Parameters

InputTypeDescriptionPossible valuesExample
typestring

Required

The object's type.

You must set a value of image.

image
imgtypestring

Required

The image type.

You must set a value of icon. icon
brandingpkgstring

The branding package to modify.

If you do not specify a value, the function modifies the current branding package.

The name of a branding package on the server.mypkg
showdeletedBoolean

Required

Whether to include deleted objects.

  • 1 — List deleted objects.
  • 0 — Do not include deleted objects.
1

 

Returns

ReturnTypeDescriptionPossible valuesExample

width

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

number

integerThe item's display order.

An integer that represents the item's display order.

For example, groups display the item that uses a number value of 1 first.

1

file

stringThe item's icon filename.

An image's filename.

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

getstart

subtype

string

The item's subtype.

img is the only possible value.img

group

stringThe item's group.A string value.pref

imgtype

stringThe item's image type.icon is the only possible value.icon

url

stringThe location to which the item's icon links.A valid file path or URL.
getstarted/index.html
reqextBooleanWhether to require the image's file extension.
  • 1 — Require the file extension.
  • 0 — Do not require the file extension.

Some objects return null if the value does not exist in the dynamicui.conf file. 

1
globalBooleanWhether the object is global.
  • 1 — Global.
  • 0 — Local.

Some objects return null if the value does not exist in the dynamicui.conf file. 

1
requiredtxtstringText that displays for required items.A string value.Requires
originstringThe item's origin.

A string value.

Items that originated in cPanel-provided themes return x3 (System).

x3 (System)
deletedBooleanWhether the function deleted the item.
  • 1 — The function deleted the item.
  • 0 — The function did not delete the item.
0

description

stringThe item's display name.

A string value.

 

Getting Started Wizard

height

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

htmldescription

string

The item's display name, with any HTML elements.

A string value that may contain HTML code.

Getting Started Wizard

type

stringThe item's type.image is the only possible value.image
resultBoolean

Whether the function succeeded.

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