# cPanel API 2 Functions - Branding::brandingeditor
Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.
## Description
This function updates objects in a branding package's `dynamicui.conf`
file.
div
Note:
cPanel API 2's `Branding` module **only** modifies data for the x3 theme. We removed the x3 theme. For more information, read our cPanel Deprecation Plan documentation.
Warning:
We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists.
## Examples
WHM API (JSON)
```undefined syntaxhighlighter-pre
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"
```
Note:
For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.
LiveAPI PHP Class
```undefined syntaxhighlighter-pre
$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',
)
);
```
Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).
LiveAPI Perl Module
```undefined syntaxhighlighter-pre
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',
}
);
```
Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system).
cPanel Tag System (deprecated)
Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system).
- 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage) documentation.
Command Line
```undefined syntaxhighlighter-pre
cpapi2 --user=username Branding brandingeditor type=image imgtype=icon showdeleted=1
```
div
Notes:
- You **must** URI-encode values.
- `username` represents your account-level username.
- You **must** run the `--user=username` option.
- For more information and additional output options, read our [Guide to cPanel API 2](/cpanel-api-2) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:
```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```
br
Output (JSON)
```undefined syntaxhighlighter-pre
{
"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 API Shell",
"height": "32",
"htmldescription": "cPanel API 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": "MIME Types",
"height": "32",
"htmldescription": "MIME 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"
}
}
```
div
Note:
Use cPanel's *API Shell* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.
## Parameters
table
colgroup
col
col
col
col
col
thead
tr
th
Input
th
Type
th
Description
th
Possible values
th
Example
tbody
tr
td
code
type
td
em
string
td
p
strong
Required
p
The object's type.
td
p
You
strong
must
set a value of
code
image
.
td
code
image
tr
td
code
imgtype
td
em
string
td
p
strong
Required
p
The image type.
td
span
You
strong
must
span
set a value of
code
icon
.
span
td
code
icon
tr
td
code
brandingpkg
td
em
string
td
p
The branding package to modify.
p
If you do not specify a value, the function modifies the current branding package.
td
The name of a branding package on the server.
td
code
mypkg
tr
td
code
showdeleted
td
em
Boolean
td
p
strong
Required
p
Whether to include deleted objects.
td
ul
li
code
1
— List deleted objects.
li
code
0
— Do not include deleted objects.
td
code
1
## Returns
table
colgroup
col
col
col
col
col
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
p
code
width
td
em
integer
td
The item's icon's width.
td
An integer that represents an image's width, in pixels.
td
code
33
tr
td
p
code
number
td
em
integer
td
The item's display order.
td
p
An integer that represents the item's display order.
p
For example, groups display the item that uses a
code
number
value of
code
1
first.
td
code
1
tr
td
p
code
file
td
em
string
td
The item's icon filename.
td
div
p
An image's filename.
br
p
This image
strong
must
exist in the
code
/usr/local/cpanel/base/frontend/theme/branding/
directory, where
code
theme
represents the current branding theme.
td
code
getstart
tr
td
p
code
subtype
td
em
string
td
p
The item's subtype.
td
code
img
is the only possible value.
td
code
img
tr
td
p
code
group
td
em
string
td
The item's group.
td
A string value.
td
code
pref
tr
td
p
code
imgtype
td
em
string
td
The item's image type.
td
code
icon
is the only possible value.
td
code
icon
tr
td
p
code
url
td
em
string
td
The location to which the item's icon links.
td
A valid file path or URL.
td
code
getstarted/index.html
tr
td
code
reqext
td
em
Boolean
td
Whether to require the image's file extension.
td
div
ul
li
code
1
— Require the file extension.
li
code
0
— Do not require the file extension.
p
Some objects return
code
null
if the value does not exist in the
code
dynamicui.conf
file.
td
code
1
tr
td
code
global
td
em
Boolean
td
Whether the object is global.
td
div
ul
li
code
1
— Global.
li
code
0
— Local.
p
Some objects return
code
null
if the value does not exist in the
code
dynamicui.conf
file.
td
code
1
tr
td
code
requiredtxt
td
em
string
td
Text that displays for required items.
td
A string value.
td
code
Requires
tr
td
code
origin
td
em
string
td
The item's origin.
td
p
A string value.
p
Items that originated in cPanel-provided themes return
code
x3 (System)
.
td
code
x3 (System)
tr
td
code
deleted
td
em
Boolean
td
Whether the function deleted the item.
td
ul
li
code
1
— The function deleted the item.
li
code
0
— The function did not delete the item.
td
code
0
tr
td
p
code
description
td
em
string
td
The item's display name.
td
p
A string value.
p
br
td
code
Getting Started Wizard
tr
td
p
code
height
td
em
integer
td
The item's icon's height.
td
An integer that represents an image's height, in pixels.
td
code
32
tr
td
p
code
htmldescription
td
em
string
td
p
The item's display name, with any HTML elements.
td
p
A string value that may contain HTML code.
td
code
Getting Started Wizard
tr
td
p
code
type
td
em
string
td
The item's type.
td
code
image
is the only possible value.
td
code
image
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
— The function succeeded.
li
code
0
— The function failed.
td
code
1