v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Branding
Application Information

Return multiple apps' info from dynamicui.conf

This function retrieves an application's information from a specific theme's dynamicui.conf file.

get/Branding/get_applications

Query parameters

app_keysstring
Example:addon_domains,ftp_accounts,anonymous_ftp

A comma-separated list of an application feature names. If you do not specify this parameter, the output will include all of the applications that the dynamicui.conf file contains.

Note:

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "get_applications",
  "module": "Branding",
  "result": {
    "data": {
      "addon_domains": {
        "acontent": "",
        "base64_png_image": "",
        "feature": "addondomains",
        "file": "addon_domains",
        "group": "domains",
        "height": "48",
        "if": "$HASROLE{'WebServer'}",
        "imgtype": "icon",
        "implements": "Domains_AddonDomains",
        "itemdesc": "Addon Domains",
        "itemorder": "3",
        "key": "addon_domains",
        "onclick": "",
        "plainitemdesc": "Addon Domains",
        "searchtext": "Domains Addon domain Addon Domains",
        "subtype": "img",
        "target": "",
        "type": "image",
        "url": "addon/index.html",
        "width": "48"
      },
      "anonymous_ftp": {
        "acontent": "",
        "base64_png_image": "",
        "feature": "ftpaccts",
        "file": "anonymous_ftp",
        "group": "files",
        "height": "48",
        "if": "$SERVICEPROVIDED{'ftp'} && $hasanonftp",
        "imgtype": "icon",
        "itemdesc": "Anonymous FTP",
        "itemorder": "8",
        "key": "anonymous_ftp",
        "onclick": "",
        "plainitemdesc": "Anonymous FTP",
        "searchtext": "Anonymous FTP anonymousftp",
        "subtype": "img",
        "target": "",
        "touch": "ftp",
        "type": "image",
        "url": "ftp/anonymous.html",
        "width": "48"
      },
      "ftp_accounts": {
        "acontent": "",
        "base64_png_image": "",
        "feature": "ftpaccts",
        "file": "ftp_accounts",
        "group": "files",
        "height": "48",
        "if": "$SERVICEPROVIDED{'ftp'}",
        "imgtype": "icon",
        "itemdesc": "FTP Accounts",
        "itemorder": "6",
        "key": "ftp_accounts",
        "onclick": "",
        "plainitemdesc": "FTP Accounts",
        "searchtext": "FTP Accounts ftp create",
        "subtype": "img",
        "target": "",
        "touch": "ftp",
        "type": "image",
        "url": "ftp/accounts.html",
        "width": "48"
      }
    },
    "status": 1
  }
}