v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

Branding

Application Information

Return app's info from sitemap.json

This function retrieves an application's information from a specific theme's sitemap.json file.

get/Branding/get_information_for_applications

Query parameters

docrootstring path required

Example:/usr/local/cpanel/base/webmail/jupiter

The absolute path to the directory containing the sitemap.json file. This is the path to your theme's document root.

app_keysstring

Example:email_filters

A comma-separated list of Appkey names. If you do not specify this parameter, the output will include all of the applications that the sitemap.json file contains.

Note:

This value must match an application's key value in the sitemap.json file. For more information, read our Guide to cPanel Interface Customization - Appkeys documentation.

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_information_for_applications",
  "module": "Branding",
  "result": {
    "status": 1
  }
}