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

Description


Important:

 Ruby on Rails does not function on Amazon Linux servers.

This function returns the dynamicui.conf file's contents.

Warning:

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


Note:

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

Examples


 WHM API (JSON)
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Branding&cpanel_jsonapi_func=preloadconf


Note:

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

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Return the contents of the dynamicui.conf file.
$get_dynamicui = $cpanel->api2(
    'Branding', 'preloadconf'
 );


Note:

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

 

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Return the contents of the dynamicui.conf file.
my $get_dynamicui = $cpliveapi->api2(
    'Branding', 'preloadconf',
 );


Note:

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

 

 cPanel Tag System (deprecated)


Warnings:

  • In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

 Command Line
cpapi2 --user=username Branding preloadconf


Notes:

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

    /usr/local/cpanel/bin/cpapi2

 Output (JSON)
 {
  "cpanelresult": {
    "apiversion": 2,
    "func": "preloadconf",
    "data": [
      "ftpaccounts",
      {
        "width": "32",
        "itemorder": "7",
        "file": "ftpaccounts",
        "height": "32",
        "itemdesc": "FTP Accounts",
        "feature": "ftpaccts",
        "group": "files",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "ftp create account",
        "url": "ftp/accounts.html",
        "type": "image",
        "touch": "ftp"
      },
      "top-header-bg",
      {
        "width": "variable",
        "subtype": "bg",
        "imgtype": "heading",
        "file": "top-header-bg",
        "type": "image",
        "height": "145"
      },
      "cpanelAPI",
      {
        "width": "32",
        "itemorder": "14",
        "file": "cpanelAPI",
        "itemdesc": "<abbr title="Application Programming Interface" class="initialism">API</abbr> Shell",
        "height": "32",
        "if": "$CONF{'api_shell'} && $isreseller",
        "feature": "api_shell",
        "subtype": "img",
        "group": "advanced",
        "imgtype": "icon",
        "url": "api_shell/index.html",
        "type": "image"
      },
      "button-bg",
      {
        "width": "22",
        "subtype": "bg",
        "imgtype": "ui",
        "file": "button-bg",
        "type": "image",
        "height": "14"
      },
      "sprites.html",
      {
        "file": "sprites.html",
        "type": "html"
      },
      "password",
      {
        "width": "32",
        "itemorder": "3",
        "file": "password",
        "height": "32",
        "itemdesc": "Change Password",
        "feature": "password",
        "group": "pref",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "password change",
        "url": "passwd/index.html",
        "type": "image"
      },
      "defaultemailacct",
      {
        "width": "32",
        "itemorder": "7",
        "file": "defaultemailacct",
        "height": "32",
        "itemdesc": "Default Address",
        "feature": "defaultaddress",
        "group": "mail",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "default address",
        "url": "mail/def.html",
        "type": "image"
      },
      "stdheader.html",
      {
        "file": "stdheader.html",
        "type": "html"
      },
      "urchin",
      {
        "width": "43",
        "itemorder": "30",
        "file": "urchin",
        "height": "32",
        "itemdesc": "Urchin Stats",
        "if": "$hasurchin",
        "group": "logs",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "urchin <abbr title="statistics">stats</abbr>",
        "url": "stats/urchin.html",
        "type": "image"
      },
      "hdspace",
      {
        "width": "32",
        "itemorder": "5",
        "file": "hdspace",
        "height": "32",
        "itemdesc": "Disk Space Usage",
        "feature": "diskusageviewer",
        "group": "files",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "d space usage disk-usage",
        "url": "diskusage/index.html",
        "type": "image"
      },
      "tutorials",
      {
        "width": "33",
        "itemorder": "2",
        "file": "tutorials",
        "height": "32",
        "itemdesc": "Video Tutorials",
        "feature": "videotut",
        "subtype": "img",
        "acontent": "target="_blank"",
        "group": "pref",
        "imgtype": "icon",
        "searchtext": "tutorials video",
        "url": "tutorial.html",
        "type": "image"
      },
      "aqua-hd-bg",
      {
        "width": "18",
        "subtype": "bg",
        "imgtype": "ui",
        "file": "aqua-hd-bg",
        "type": "image",
        "height": "22"
      },
      "start32",
      {
        "width": "32",
        "subtype": "img",
        "imgtype": "ui",
        "file": "start32",
        "type": "image",
        "height": "32"
      },
      "enduserlve",
      {
        "width": "32",
        "itemorder": "999",
        "version": "1.0",
        "file": "enduserlve",
        "itemdesc": "Resource Usage",
        "height": "32",
        "if": "$hascloudlinux",
        "feature": "enduserlve",
        "group": "logs",
        "subtype": "img",
        "imgtype": "icon",
        "url": "stats/resourceusage.html",
        "type": "image"
      },
      "hd",
      {
        "width": "32",
        "itemorder": "1",
        "file": "hd",
        "height": "32",
        "itemdesc": "Backups",
        "feature": "backup",
        "group": "files",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "backup restore",
        "url": "backup/index.html",
        "type": "image"
      },
      "redirects",
      {
        "width": "33",
        "itemorder": "4",
        "file": "redirects",
        "height": "32",
        "itemdesc": "Redirects",
        "feature": "redirects",
        "group": "domains",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "rewrite modrewrite",
        "url": "mime/redirect.html",
        "type": "image"
      },
      "php-pear",
      {
        "width": "32",
        "itemorder": "5",
        "file": "php-pear",
        "height": "32",
        "itemdesc": "PHP PEAR Packages",
        "if": "$haspear",
        "feature": "modules-php-pear",
        "group": "software",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "php pear packages",
        "url": "module_installers/index.html?lang=php-pear",
        "type": "image"
      },
      "csvimport",
      {
        "width": "35",
        "itemorder": "12",
        "file": "csvimport",
        "height": "32",
        "itemdesc": "Import Addresses and Forwarders",
        "feature": "csvimport",
        "group": "mail",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "import mail csv xls",
        "url": "mail/csvimport.html",
        "type": "image",
        "module": "CSVImport"
      },
      "aqua-hd-lt",
      {
        "width": "7",
        "subtype": "img",
        "imgtype": "ui",
        "file": "aqua-hd-lt",
        "type": "image",
        "height": "22"
      },
      "errorpage",
      {
        "width": "32",
        "itemorder": "6",
        "file": "errorpage",
        "height": "32",
        "itemdesc": "Error Pages",
        "feature": "errpgs",
        "group": "advanced",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "errorlog error_log error log",
        "url": "err/index.html",
        "type": "image"
      },
      "hotlinkprotect",
      {
        "width": "32",
        "itemorder": "5",
        "file": "hotlinkprotect",
        "height": "32",
        "itemdesc": "HotLink Protection",
        "feature": "hotlink",
        "group": "sec",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "protection",
        "url": "mime/hotlink.html",
        "type": "image"
      },
      "group_domains",
      {
        "width": "32",
        "grouporder": "6",
        "file": "group_domains",
        "height": "32",
        "groupdesc": "Domains",
        "group": "domains",
        "subtype": "img",
        "imgtype": "icon",
        "type": "image"
      },
      "webemail",
      {
        "width": "32",
        "itemorder": "2",
        "file": "webemail",
        "height": "32",
        "itemdesc": "Webmail",
        "feature": "webmail",
        "group": "mail",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "webmail",
        "url": "webmaillogin.html",
        "type": "image"
      },
      "errorlogs",
      {
        "width": "32",
        "itemorder": "8",
        "file": "errorlogs",
        "height": "32",
        "itemdesc": "Error Log",
        "feature": "errlog",
        "group": "logs",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "errorlog error_log error log",
        "url": "stats/errlog.html",
        "type": "image"
      },
      "group_pref",
      {
        "width": "32",
        "grouporder": "1",
        "file": "group_pref",
        "height": "32",
        "groupdesc": "Preferences",
        "group": "pref",
        "subtype": "img",
        "imgtype": "icon",
        "type": "image"
      },
      "home_on",
      {
        "width": "44",
        "subtype": "img",
        "imgtype": "heading",
        "file": "home_on",
        "type": "image",
        "height": "35"
      },
      "favicon",
      {
        "width": "16",
        "subtype": "img",
        "imgtype": "ui",
        "file": "favicon",
        "type": "image",
        "height": "16"
      },
      "clam",
      {
        "width": "32",
        "itemorder": "11",
        "file": "clam",
        "height": "32",
        "itemdesc": "Virus Scanner",
        "feature": "clamavconnector_scan",
        "group": "advanced",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "virus protection scan scanner clam clamav",
        "url": "clamavconnector/index.html",
        "type": "image",
        "touch": "clamav"
      },
      "homeb",
      {
        "width": "20",
        "subtype": "img",
        "imgtype": "ui",
        "file": "homeb",
        "type": "image",
        "height": "19"
      },
      "submit-support",
      {
        "width": "32",
        "itemorder": "10",
        "file": "submit-support",
        "height": "32",
        "itemdesc": "Submit a Support Request",
        "if": "$CPFLAGS{'pro'} && $is_support_enabled",
        "feature": "cpanelpro_support",
        "group": "advanced",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "ticket helpdesk",
        "url": "cpanelpro/support.html",
        "type": "image",
        "module": "SupportRequest"
      },
      "phpMyAdmin",
      {
        "width": "45",
        "itemorder": "3",
        "file": "phpMyAdmin",
        "height": "34",
        "itemdesc": "phpMyAdmin",
        "feature": "phpmyadmin",
        "subtype": "img",
        "acontent": "target="_blank"",
        "group": "db",
        "imgtype": "icon",
        "searchtext": "mysql database",
        "url": "sql/PhpMyAdmin.html",
        "type": "image"
      },
      "perl",
      {
        "width": "32",
        "itemorder": "4",
        "file": "perl",
        "height": "32",
        "itemdesc": "Perl Modules",
        "if": "$hasperl",
        "feature": "modules-perl",
        "group": "software",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "module perl",
        "url": "module_installers/index.html?lang=perl",
        "type": "image"
      },
      "index",
      {
        "width": "32",
        "itemorder": "5",
        "file": "index",
        "height": "32",
        "itemdesc": "Index Manager",
        "feature": "indexmanager",
        "group": "advanced",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "index manager",
        "url": "indexmanager/index.html",
        "type": "image",
        "onclick": "show_optionselect('index'); return false;"
      },
      "stdmheader.html",
      {
        "file": "stdmheader.html",
        "type": "html"
      },
      "ipdeny",
      {
        "width": "32",
        "itemorder": "2",
        "file": "ipdeny",
        "height": "32",
        "itemdesc": "IP Address Deny Manager",
        "feature": "ipdeny",
        "group": "sec",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "deny block",
        "url": "denyip/index.html",
        "type": "image"
      },
      "maillist",
      {
        "width": "32",
        "itemorder": "8",
        "file": "maillist",
        "height": "32",
        "itemdesc": "Mailing Lists",
        "if": "!$CONF{'skipmailman'}",
        "feature": "lists",
        "group": "mail",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "mailman mailing lists",
        "url": "mail/lists.html",
        "type": "image"
      },
      "subdomains",
      {
        "width": "43",
        "itemorder": "1",
        "file": "subdomains",
        "height": "32",
        "itemdesc": "Subdomains",
        "feature": "subdomains",
        "group": "domains",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "domain",
        "url": "subdomain/index.html",
        "type": "image"
      },
      "sprites_ui.html",
      {
        "file": "sprites_ui.html",
        "type": "html"
      },
      "logout_on",
      {
        "width": "44",
        "subtype": "img",
        "imgtype": "heading",
        "file": "logout_on",
        "type": "image",
        "height": "41"
      },
      "simplezoneedit",
      {
        "width": "32",
        "itemorder": "10",
        "file": "simplezoneedit",
        "height": "32",
        "itemdesc": "Simple DNS Zone Editor",
        "feature": "simplezoneedit",
        "group": "domains",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "DNS zone CNAME TTL",
        "url": "zoneedit/simple.html",
        "type": "image"
      },
      "cgi-center",
      {
        "width": "32",
        "itemorder": "1",
        "file": "cgi-center",
        "height": "32",
        "itemdesc": "CGI Center",
        "feature": "cgi",
        "group": "software",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "cgi",
        "url": "cgi/index.html",
        "type": "image"
      },
      "userfiltering",
      {
        "width": "32",
        "itemorder": "10",
        "file": "userfiltering",
        "height": "32",
        "itemdesc": "User-Level Filtering",
        "feature": "blockers",
        "group": "mail",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "user level filtered",
        "url": "mail/filters/managefilters.html",
        "type": "image"
      },
      "bottom_bg",
      {
        "width": "variable",
        "subtype": "bg",
        "imgtype": "heading",
        "file": "bottom_bg",
        "type": "image",
        "height": "23"
      },
      "webalizerftp",
      {
        "width": "32",
        "itemorder": "5",
        "file": "webalizerftp",
        "height": "32",
        "itemdesc": "Webalizer FTP",
        "if": "!$CONF{'skipwebalizer'} $CPDATA{'FEATURE-WEBALIZER'}",
        "feature": "webalizer",
        "group": "logs",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "webalizer <abbr title="statistics">stats</abbr> ftp",
        "url": "stats/webalizerftp_landing.html",
        "type": "image",
        "touch": "ftp"
      },
      "index.html",
      {
        "file": "index.html",
        "type": "html"
      },
      "getstart-icon",
      {
        "width": "72",
        "subtype": "img",
        "imgtype": "ui",
        "file": "getstart-icon",
        "type": "image",
        "height": "72"
      },
      "rails",
      {
        "width": "32",
        "itemorder": "8",
        "file": "rails",
        "height": "32",
        "itemdesc": "Ruby on Rails",
        "if": "$hasrails",
        "feature": "ror",
        "group": "software",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "ruby rails gems",
        "url": "ror/index.html",
        "type": "image",
        "module": "RoR"
      },
      "apache",
      {
        "width": "45",
        "itemorder": "1",
        "file": "apache",
        "height": "30",
        "itemdesc": "Apache Handlers",
        "feature": "handlers",
        "group": "advanced",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "apache handlers extension configure",
        "url": "mime/handle.html",
        "type": "image"
      },
      "x3-hd-close",
      {
        "width": "17",
        "subtype": "img",
        "imgtype": "ui",
        "file": "x3-hd-close",
        "type": "image",
        "height": "18"
      },
      "mime-types",
      {
        "width": "32",
        "itemorder": "12",
        "file": "mime-types",
        "height": "32",
        "itemdesc": "MIME Types",
        "feature": "mime",
        "group": "advanced",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "mime mimetype types",
        "url": "mime/mime.html",
        "type": "image"
      },
      "scripts-library",
      {
        "width": "32",
        "itemorder": "2",
        "file": "scripts-library",
        "height": "32",
        "itemdesc": "Site Software",
        "feature": "addoncgi",
        "group": "software",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "addons software",
        "url": "addoncgi/cpaddons.html",
        "type": "image"
      },
      "tbl-bg",
      {
        "width": "22",
        "subtype": "bg",
        "imgtype": "ui",
        "file": "tbl-bg",
        "type": "image",
        "height": "21"
      },
      "preview",
      {
        "width": "&nbsp;",
        "subtype": "img",
        "imgtype": "preview",
        "file": "preview",
        "type": "image",
        "height": "&nbsp;"
      },
      "changelang",
      {
        "width": "32",
        "itemorder": "7",
        "file": "changelang",
        "height": "32",
        "itemdesc": "Change Language",
        "feature": "setlang",
        "group": "pref",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "language setlang",
        "url": "setlang/index.html",
        "type": "image"
      },
      "mysql-remoteaccess",
      {
        "width": "45",
        "itemorder": "4",
        "file": "mysql-remoteaccess",
        "height": "31",
        "itemdesc": "Remote MySQL",
        "feature": "mysql",
        "group": "db",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "remote mysql",
        "url": "sql/managehost.html",
        "type": "image"
      },
      "favorites",
      {
        "width": "32",
        "itemorder": "8",
        "file": "favorites",
        "height": "32",
        "itemdesc": "Shortcuts",
        "feature": "setlang",
        "group": "pref",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "bookmarks",
        "url": "shortcuts/index.html",
        "type": "image"
      },
      "password-protect",
      {
        "width": "32",
        "itemorder": "1",
        "file": "password-protect",
        "height": "32",
        "itemdesc": "Password Protect Directories",
        "feature": "webprotect",
        "group": "sec",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "password protect protect password",
        "url": "htaccess/index.html",
        "type": "image",
        "onclick": "show_optionselect('password-protect'); return false;"
      },
      "addondomain",
      {
        "width": "33",
        "itemorder": "2",
        "file": "addondomain",
        "height": "32",
        "itemdesc": "Addon Domains",
        "feature": "addondomains",
        "group": "domains",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "domain",
        "url": "addon/index.html",
        "type": "image"
      },
      "keys",
      {
        "width": "32",
        "itemorder": "7",
        "file": "keys",
        "height": "32",
        "itemdesc": "GnuPG Keys",
        "feature": "pgp",
        "group": "sec",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "gpg keys",
        "url": "gpg/index.html",
        "type": "image"
      },
      "group_sec",
      {
        "width": "32",
        "grouporder": "5",
        "file": "group_sec",
        "height": "32",
        "groupdesc": "Security",
        "group": "sec",
        "subtype": "img",
        "imgtype": "icon",
        "type": "image"
      },
      "ssl-manager",
      {
        "width": "32",
        "itemorder": "3",
        "file": "ssl-manager",
        "height": "32",
        "itemdesc": "SSL/TLS Manager",
        "feature": "sslmanager",
        "group": "sec",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "certificate key csr",
        "url": "ssl/index.html",
        "type": "image"
      },
      "parkeddomains",
      {
        "width": "32",
        "itemorder": "3",
        "file": "parkeddomains",
        "height": "32",
        "itemdesc": "Parked Domains",
        "feature": "parkeddomains",
        "group": "domains",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "domain",
        "url": "park/index.html",
        "type": "image"
      },
      "supportinfo_include.html",
      {
        "global": "1",
        "file": "supportinfo_include.html",
        "type": "html"
      },
      "cpanel_parsed_css.html",
      {
        "file": "cpanel_parsed_css.html",
        "type": "html"
      },
      "sec_policy",
      {
        "width": "32",
        "itemorder": "17",
        "file": "sec_policy",
        "height": "32",
        "itemdesc": "Security Policy",
        "if": "$CONF{'SecurityPolicy::SourceIPCheck'}",
        "group": "pref",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "ip access questions login password security",
        "url": "security/index.html",
        "type": "image"
      },
      "postgresql",
      {
        "width": "32",
        "itemorder": "5",
        "file": "postgresql",
        "height": "32",
        "itemdesc": "PostgreSQL Databases",
        "if": "$haspostgres",
        "feature": "postgres",
        "group": "db",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "postgres postgresql database",
        "url": "psql/index.html",
        "type": "image"
      },
      "logout_off",
      {
        "width": "44",
        "subtype": "img",
        "imgtype": "heading",
        "file": "logout_off",
        "type": "image",
        "height": "41"
      },
      "accept",
      {
        "width": "16",
        "subtype": "img",
        "imgtype": "ui",
        "file": "accept",
        "type": "image",
        "height": "16"
      },
      "sprites_yui.html",
      {
        "file": "sprites_yui.html",
        "type": "html"
      },
      "spamassassin",
      {
        "width": "46",
        "itemorder": "4",
        "file": "spamassassin",
        "height": "32",
        "itemdesc": "Apache SpamAssassinu2122",
        "if": "!$CONF{'skipspamassassin'} $CPDATA{'FEATURE-SPAMASSASSIN'}",
        "feature": "spamassassin",
        "group": "mail",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "spamassassin apache spam email",
        "url": "mail/spam/spam.html",
        "type": "image"
      },
      "image-manager",
      {
        "width": "32",
        "itemorder": "4",
        "file": "image-manager",
        "height": "32",
        "itemdesc": "Image Manager",
        "feature": "cpanelpro_images",
        "group": "advanced",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "image resize manager scaler thumbnailer format",
        "url": "cpanelpro/images.html",
        "type": "image",
        "module": "ImageManager"
      },
      "mysql",
      {
        "width": "45",
        "itemorder": "1",
        "file": "mysql",
        "height": "31",
        "itemdesc": "MySQL Databases",
        "feature": "mysql",
        "group": "db",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "mysql database",
        "url": "sql/index.html",
        "type": "image"
      },
      "ssh-shell-access",
      {
        "width": "37",
        "itemorder": "4",
        "file": "ssh-shell-access",
        "height": "32",
        "itemdesc": "SSH Shell Access",
        "feature": "ssh",
        "group": "sec",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "ssh secure shell sftp",
        "url": "telnet/index.html",
        "type": "image"
      },
      "analogstats",
      {
        "width": "32",
        "itemorder": "7",
        "file": "analogstats",
        "height": "32",
        "itemdesc": "Analog Stats",
        "if": "!$CONF{'skipanalog'} $CPDATA{'FEATURE-ANALOG'}",
        "feature": "analog",
        "group": "logs",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "analog <abbr title="statistics">stats</abbr>",
        "url": "stats/analog_landing.html",
        "type": "image"
      },
      "reject",
      {
        "width": "16",
        "subtype": "img",
        "imgtype": "ui",
        "file": "reject",
        "type": "image",
        "height": "16"
      },
      "top-logo_vps2",
      {
        "width": "variable",
        "subtype": "logo",
        "imgtype": "logo",
        "file": "top-logo_vps2",
        "type": "image",
        "height": "variable"
      },
      "local.css",
      {
        "width": "0",
        "subtype": "css",
        "imgtype": "css",
        "file": "local.css",
        "type": "css",
        "height": "0"
      },
      "stop32",
      {
        "width": "32",
        "subtype": "img",
        "imgtype": "ui",
        "file": "stop32",
        "type": "image",
        "height": "32"
      },
      "lookandfeel",
      {
        "width": "32",
        "itemorder": "6",
        "file": "lookandfeel",
        "height": "32",
        "itemdesc": "Change Style",
        "feature": "style",
        "group": "pref",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "skin theme",
        "url": "style/index.html",
        "type": "image"
      },
      "x3-hd-closehover",
      {
        "width": "17",
        "subtype": "img",
        "imgtype": "ui",
        "file": "x3-hd-closehover",
        "type": "image",
        "height": "18"
      },
      "group_advanced",
      {
        "width": "32",
        "grouporder": "10",
        "file": "group_advanced",
        "height": "32",
        "groupdesc": "Advanced",
        "group": "advanced",
        "subtype": "img",
        "imgtype": "icon",
        "type": "image"
      },
      "postgresql-wizard",
      {
        "width": "45",
        "_empty_": null,
        "itemorder": "6",
        "file": "postgresql-wizard",
        "height": "31",
        "itemdesc": "PostgreSQL Database Wizard",
        "if": "$haspostgres",
        "feature": "postgres",
        "group": "db",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "postgres postgresql database",
        "url": "psql/wizard1.html",
        "type": "image"
      },
      "top-billboard",
      {
        "width": "variable",
        "subtype": "compleximg",
        "imgtype": "heading",
        "file": "top-billboard",
        "type": "image",
        "height": "145"
      },
      "legacy_filemanager",
      {
        "width": "32",
        "itemorder": "4",
        "file": "legacy_filemanager",
        "height": "32",
        "itemdesc": "Legacy File Manager",
        "feature": "filemanager",
        "subtype": "img",
        "acontent": "target="_blank"",
        "group": "files",
        "imgtype": "icon",
        "searchtext": "file manager file-manager",
        "url": "files/index.html?showhidden=1&amp;dir=/public_html",
        "type": "image",
        "onclick": "show_optionselect('files'); return false;"
      },
      "button-bg-over",
      {
        "width": "22",
        "subtype": "bg",
        "imgtype": "ui",
        "file": "button-bg-over",
        "type": "image",
        "height": "14"
      },
      "stdfooter.html",
      {
        "file": "stdfooter.html",
        "type": "html"
      },
      "group_mail",
      {
        "width": "32",
        "grouporder": "2",
        "file": "group_mail",
        "height": "32",
        "groupdesc": "Mail",
        "group": "mail",
        "subtype": "img",
        "imgtype": "icon",
        "type": "image"
      },
      "getstart",
      {
        "width": "33",
        "itemorder": "1",
        "file": "getstart",
        "height": "32",
        "itemdesc": "Getting Started Wizard",
        "feature": "getstart",
        "group": "pref",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "getting started wizard",
        "url": "getstarted/index.html",
        "type": "image"
      },
      "chooselog",
      {
        "width": "32",
        "itemorder": "9",
        "file": "chooselog",
        "height": "32",
        "itemdesc": "Choose Log Programs",
        "if": "$any_stats_enabled",
        "feature": "statselect",
        "group": "logs",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "<abbr title="statistics">stats</abbr> manager",
        "url": "statmanager/index.html",
        "type": "image"
      },
      "webalizerlog",
      {
        "width": "32",
        "itemorder": "4",
        "file": "webalizerlog",
        "height": "32",
        "itemdesc": "Webalizer",
        "if": "!$CONF{'skipwebalizer'} $CPDATA{'FEATURE-WEBALIZER'}",
        "feature": "webalizer",
        "group": "logs",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "webalizer <abbr title="statistics">stats</abbr>",
        "url": "stats/webalizer_landing.html",
        "type": "image"
      },
      "ftpcontrol",
      {
        "width": "32",
        "itemorder": "8",
        "file": "ftpcontrol",
        "height": "32",
        "itemdesc": "FTP Session Control",
        "feature": "ftpaccts",
        "group": "files",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "ftp session accounts",
        "url": "ftp/session.html",
        "type": "image",
        "touch": "ftp"
      },
      "webmaillogininclude.html",
      {
        "file": "webmaillogininclude.html",
        "type": "html"
      },
      "optimizews",
      {
        "width": "45",
        "itemorder": "20",
        "file": "optimizews",
        "height": "32",
        "itemdesc": "Optimize Website",
        "if": "$hasmoddeflate",
        "feature": "optimizews",
        "subtype": "img",
        "group": "software",
        "imgtype": "icon",
        "searchtext": "optimize",
        "url": "optimize/index.html",
        "type": "image"
      },
      "dfiltering",
      {
        "width": "32",
        "itemorder": "9",
        "file": "dfiltering",
        "height": "32",
        "itemdesc": "Account-Level Filtering",
        "feature": "blockers",
        "group": "mail",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "account level filtered",
        "url": "mail/filters/userfilters.html",
        "type": "image"
      },
      "emailarch",
      {
        "width": "32",
        "itemorder": "18",
        "file": "emailarch",
        "height": "32",
        "itemdesc": "Email Archiving",
        "if": "$CONF{'emailarchive'}",
        "feature": "emailarchive",
        "group": "mail",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "email archive emailarch",
        "url": "mail/archive.html",
        "type": "image"
      },
      "getstarted-pop.html",
      {
        "file": "getstarted-pop.html",
        "type": "html"
      },
      "awstats",
      {
        "width": "32",
        "itemorder": "20",
        "file": "awstats",
        "height": "32",
        "itemdesc": "AWStats",
        "if": "!$CONF{'skipawstats'} $CPDATA{'FEATURE-AWSTATS'}",
        "feature": "awstats",
        "group": "logs",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "awstats",
        "url": "stats/awstats_landing.html",
        "type": "image"
      },
      "forwardersemail",
      {
        "width": "32",
        "itemorder": "5",
        "file": "forwardersemail",
        "height": "32",
        "itemdesc": "Forwarders",
        "feature": "forwarders || emaildomainfwd",
        "group": "mail",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "forwarders forward",
        "url": "mail/fwds.html",
        "type": "image"
      },
      "bg",
      {
        "subtype": "bg",
        "imgtype": "ui",
        "file": "bg",
        "type": "image"
      },
      "extended_statsbar.html",
      {
        "file": "extended_statsbar.html",
        "type": "html"
      },
      "phpPgAdmin",
      {
        "width": "50",
        "itemorder": "7",
        "file": "phpPgAdmin",
        "height": "32",
        "itemdesc": "phpPgAdmin",
        "if": "$haspostgres",
        "feature": "phppgadmin",
        "group": "db",
        "subtype": "img",
        "acontent": "target="_blank"",
        "imgtype": "icon",
        "searchtext": "postgresql postgres database psql",
        "url": "psql/PhpPgAdmin.html",
        "type": "image"
      },
      "whm",
      {
        "width": "45",
        "itemorder": "13",
        "file": "whm",
        "height": "32",
        "itemdesc": "WebHost Manager",
        "if": "$isreseller",
        "group": "advanced",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "webhostmanager whm",
        "url": "/xferwhm/",
        "type": "image"
      },
      "group_files",
      {
        "width": "32",
        "grouporder": "3",
        "file": "group_files",
        "height": "32",
        "groupdesc": "Files",
        "group": "files",
        "subtype": "img",
        "imgtype": "icon",
        "type": "image"
      },
      "email-reports",
      {
        "width": "32",
        "itemorder": "11",
        "file": "email-reports",
        "height": "32",
        "itemdesc": "Email Trace",
        "feature": "emailtrace",
        "group": "mail",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "email mail delivery report",
        "url": "mail/route.html",
        "type": "image",
        "module": "EmailTrack"
      },
      "help_on",
      {
        "width": "41",
        "subtype": "img",
        "imgtype": "heading",
        "file": "help_on",
        "type": "image",
        "height": "35"
      },
      "cron",
      {
        "width": "32",
        "itemorder": "7",
        "file": "cron",
        "height": "32",
        "itemdesc": "Cron Jobs",
        "feature": "cron",
        "group": "advanced",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "cronjob cron job tab edit",
        "url": "cron/index.html",
        "type": "image"
      },
      "branding",
      {
        "width": "32",
        "itemorder": "5",
        "file": "branding",
        "height": "32",
        "itemdesc": "Branding Editor",
        "if": "$isreseller",
        "group": "pref",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "skin style theme",
        "url": "resellers/branding/index.html",
        "type": "image"
      },
      "expand",
      {
        "width": "14",
        "subtype": "img",
        "imgtype": "ui",
        "file": "expand",
        "type": "image",
        "height": "14"
      },
      "zoneedit",
      {
        "width": "32",
        "itemorder": "11",
        "file": "zoneedit",
        "height": "32",
        "itemdesc": "Advanced DNS Zone Editor",
        "feature": "zoneedit",
        "group": "domains",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "DNS zone CNAME TTL",
        "url": "zoneedit/advanced.html",
        "type": "image"
      },
      "nettools",
      {
        "width": "32",
        "itemorder": "8",
        "file": "nettools",
        "height": "32",
        "itemdesc": "Network Tools",
        "feature": "nettools",
        "group": "advanced",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "traceroute tracert dns lookup dig",
        "url": "net/index.html",
        "type": "image"
      },
      "cpanel_parsed_css_local.html",
      {
        "file": "cpanel_parsed_css_local.html",
        "type": "html"
      },
      "publiccontact_include.html",
      {
        "global": "1",
        "file": "publiccontact_include.html",
        "type": "html"
      },
      "emailauth",
      {
        "width": "32",
        "itemorder": "13",
        "file": "emailauth",
        "height": "32",
        "itemdesc": "Email Authentication",
        "feature": "emailauth",
        "group": "mail",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "spf domain-keys authentication dkim",
        "url": "mail/auth.html",
        "type": "image"
      },
      "group_db",
      {
        "width": "32",
        "grouporder": "8",
        "file": "group_db",
        "height": "32",
        "groupdesc": "Databases",
        "group": "db",
        "subtype": "img",
        "imgtype": "icon",
        "type": "image"
      },
      "boxtrapper",
      {
        "width": "35",
        "itemorder": "3",
        "file": "boxtrapper",
        "height": "32",
        "itemdesc": "BoxTrapper",
        "if": "!$CONF{'skipboxtrapper'} $CPDATA{'FEATURE-BOXTRAPPER'}",
        "feature": "boxtrapper",
        "group": "mail",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "boxtrapper filter",
        "url": "mail/boxtrapper.html",
        "type": "image",
        "module": "BoxTrapper"
      },
      "anonymousmsg",
      {
        "width": "32",
        "itemorder": "9",
        "file": "anonymousmsg",
        "height": "32",
        "itemdesc": "Anonymous FTP",
        "if": "$hasanonftp",
        "feature": "ftpaccts",
        "group": "files",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "anonymous ftp",
        "url": "ftp/anonymous.html",
        "type": "image",
        "touch": "ftp"
      },
      "php",
      {
        "width": "32",
        "itemorder": "6",
        "file": "php",
        "height": "32",
        "itemdesc": "PHP Configuration",
        "feature": "php-config",
        "group": "software",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "config configuration",
        "url": "php/index.html?lang",
        "type": "image"
      },
      "responder",
      {
        "width": "32",
        "itemorder": "6",
        "file": "responder",
        "height": "32",
        "itemdesc": "Autoresponders",
        "feature": "autoresponders",
        "group": "mail",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "autoresponder",
        "url": "mail/autores.html",
        "type": "image"
      },
      "emailmx",
      {
        "width": "32",
        "itemorder": "14",
        "file": "emailmx",
        "height": "32",
        "itemdesc": "MX Entry",
        "feature": "changemx",
        "group": "mail",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "entry mx dns",
        "url": "mail/mx.html",
        "type": "image"
      },
      "webdav",
      {
        "width": "32",
        "itemorder": "6",
        "file": "webdav",
        "height": "32",
        "itemdesc": "Web Disk",
        "feature": "webdisk",
        "group": "files",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "webdav webdisk web disk",
        "url": "webdav/accounts_webdav.html",
        "type": "image"
      },
      "optionselect-pop.html",
      {
        "file": "optionselect-pop.html",
        "type": "html"
      },
      "rawaccesslogs",
      {
        "width": "32",
        "_empty_": null,
        "itemorder": "6",
        "file": "rawaccesslogs",
        "height": "32",
        "itemdesc": "Raw Access Logs",
        "feature": "rawlog",
        "subtype": "img",
        "group": "logs",
        "imgtype": "icon",
        "searchtext": "rawlogs logs access",
        "url": "raw/index.html",
        "type": "image"
      },
      "help_off",
      {
        "width": "41",
        "subtype": "img",
        "imgtype": "heading",
        "file": "help_off",
        "type": "image",
        "height": "35"
      },
      "home_off",
      {
        "width": "44",
        "subtype": "img",
        "imgtype": "heading",
        "file": "home_off",
        "type": "image",
        "height": "35"
      },
      "aqua-hd-rt",
      {
        "width": "7",
        "subtype": "img",
        "imgtype": "ui",
        "file": "aqua-hd-rt",
        "type": "image",
        "height": "22"
      },
      "group_software",
      {
        "width": "32",
        "grouporder": "9",
        "file": "group_software",
        "height": "32",
        "groupdesc": "Software and Services",
        "group": "software",
        "subtype": "img",
        "imgtype": "icon",
        "type": "image"
      },
      "top-logo",
      {
        "width": "variable",
        "subtype": "logo",
        "imgtype": "logo",
        "file": "top-logo",
        "type": "image",
        "height": "variable"
      },
      "updatecontact",
      {
        "width": "32",
        "itemorder": "4",
        "file": "updatecontact",
        "height": "32",
        "itemdesc": "Update Contact Information",
        "feature": "updatecontact",
        "group": "pref",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "email",
        "url": "contact/index.html",
        "type": "image"
      },
      "mod_security",
      {
        "width": "48",
        "itemorder": "7",
        "file": "mod_security",
        "itemdesc": "ModSecurity",
        "height": "48",
        "if": "$is_mod_security_installed",
        "feature": "modsecurity",
        "group": "sec",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "ModSecurity mod security mod_security",
        "url": "security/mod_security/index.html",
        "type": "image"
      },
      "previewsm",
      {
        "width": "Suggested Size",
        "subtype": "img",
        "imgtype": "preview",
        "file": "previewsm",
        "type": "image",
        "height": "Suggested Size"
      },
      "contactinfo_include.html",
      {
        "global": "1",
        "file": "contactinfo_include.html",
        "type": "html"
      },
      "mysql-wizard3",
      {
        "width": "45",
        "itemorder": "2",
        "file": "mysql-wizard3",
        "height": "31",
        "itemdesc": "MySQL Database Wizard",
        "feature": "mysql",
        "group": "db",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "mysql database",
        "url": "sql/wizard1.html",
        "type": "image"
      },
      "collapse",
      {
        "width": "14",
        "subtype": "img",
        "imgtype": "ui",
        "file": "collapse",
        "type": "image",
        "height": "14"
      },
      "top-logo_opt",
      {
        "width": "variable",
        "subtype": "logo",
        "imgtype": "logo",
        "file": "top-logo_opt",
        "type": "image",
        "height": "variable"
      },
      "filemanager",
      {
        "width": "32",
        "itemorder": "3",
        "file": "filemanager",
        "height": "32",
        "itemdesc": "File Manager",
        "feature": "filemanager",
        "subtype": "img",
        "acontent": "target="_blank"",
        "group": "files",
        "imgtype": "icon",
        "searchtext": "file manager file-manager",
        "url": "filemanager/index.html?showhidden=1&amp;dir=/public_html",
        "type": "image",
        "onclick": "show_optionselect('filemanager'); return false;"
      },
      "leechprotect",
      {
        "width": "32",
        "itemorder": "6",
        "file": "leechprotect",
        "height": "32",
        "itemdesc": "Leech Protect",
        "feature": "cpanelpro_leechprotect && webprotect",
        "group": "sec",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "leech protect",
        "url": "htaccess/leechprotect/leechprotect.html",
        "type": "image",
        "onclick": "show_optionselect('leechprotect'); return false;",
        "module": "LeechProtect"
      },
      "ruby",
      {
        "width": "32",
        "itemorder": "7",
        "file": "ruby",
        "height": "32",
        "itemdesc": "RubyGems",
        "if": "$hasgem",
        "feature": "modules-ruby",
        "group": "software",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "ror ruby rails gems",
        "url": "module_installers/index.html?lang=ruby",
        "type": "image"
      },
      "latestvisitors",
      {
        "width": "32",
        "itemorder": "1",
        "file": "latestvisitors",
        "height": "32",
        "itemdesc": "Latest Visitors",
        "feature": "lastvisits",
        "group": "logs",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "latest visitors",
        "url": "stats/lastvisitors_landing.html",
        "type": "image"
      },
      "networkmonitor",
      {
        "width": "32",
        "itemorder": "2",
        "file": "networkmonitor",
        "height": "32",
        "itemdesc": "Bandwidth",
        "feature": "bandwidth",
        "group": "logs",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "bandmin transfer",
        "url": "stats/bandwidth.html",
        "type": "image"
      },
      "group_logs",
      {
        "width": "32",
        "grouporder": "4",
        "file": "group_logs",
        "height": "32",
        "groupdesc": "Logs",
        "group": "logs",
        "subtype": "img",
        "imgtype": "icon",
        "type": "image"
      },
      "manageaccounts",
      {
        "width": "32",
        "itemorder": "1",
        "file": "manageaccounts",
        "height": "32",
        "itemdesc": "Email Accounts",
        "feature": "popaccts",
        "group": "mail",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "pop imap smtp new account",
        "url": "mail/pops.html",
        "type": "image"
      },
      "backup-wizard",
      {
        "width": "45",
        "itemorder": "2",
        "file": "backup-wizard",
        "height": "32",
        "itemdesc": "Backup Wizard",
        "feature": "backup",
        "group": "files",
        "subtype": "img",
        "imgtype": "icon",
        "searchtext": "backup wizard restore",
        "url": "backup/wizard.html",
        "type": "image"
      },
      "tbl-bg-over",
      {
        "width": "2",
        "subtype": "bg",
        "imgtype": "ui",
        "file": "tbl-bg-over",
        "type": "image",
        "height": "21"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Branding"
  }
}


Note:

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

 

Parameters

This function does not accept parameters.

Returns


Note:

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

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

ReturnTypeDescriptionPossible valuesExample
item namehash

A hash of information about each dynamicui.conf item.

Note:

The hash's name is the item's name. 

Each hash includes the width, integer, file, itemdesc, height, if, feature, subtype, group, searchtext, itemtype, url, type, text, and module returns if they exist in the dynamicui.conf file. 

width

integer

The item's icon's width.

The function returns this value in the item name hash.

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

itemorder

integer

The item's display order.

The function returns this value in the item name hash .

An integer that represents the item's display order.

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

1

file

string

The item's icon filename.

The function returns this value in the item name hash .

An image's filename.

Note:

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

getstart

itemdesc

string

The item's display name.

The function returns this value in the item name hash .

A string value.

 

Getting Started Wizard

height

integer

The item's icon's height.

The function returns this value in the item name hash .

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

if

string

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

The function returns this value in the item name hash .

Conditional arguments that determine whether to display the item.

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

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

$isreseller

feature

string

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

The function returns this value in the item name hash .

A feature name.getstart

subtype

string

The item's subtype.

The function returns this value in the item name hash .

img is the only possible value.img

group

string

The item's group.

The function returns this value in the item name hash .

A string value.pref

searchtext

string

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

The function returns this value in the item name hash .

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

imgtype

string

The item's image type.

The function returns this value in the item name hash .

icon is the only possible value.icon

url

string

The location to which the item's icon links.

The function returns this value in the item name hash .

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

type

string

The item's type.

The function returns this value in the item name hash .

image is the only possible value.image

touch

string

The name of a touch file that controls whether the item displays in the cPanel interface.

The function returns this value in the item name hash .

A touch file's filename.ftp

module

string

The name of the related cPanel API 2 module.

The function returns this value in the item name hash .

A cPanel API 2 module name.BoxTrapper
resultBoolean

Whether the function succeeded.

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