Return app's info from sitemap.json

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

SecurityBasicAuth

Request

query Parameters

docroot required	string <path> The absolute path to the directory containing the `sitemap.json` file. This is the path to your theme's document root. Example: docroot=/usr/local/cpanel/base/webmail/jupiter
app_keys	string 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. Example: app_keys=email_filters

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/Branding/get_information_for_applications

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Branding \
  get_information_for_applications \
  docroot='/usr/local/cpanel/base/webmail/jupiter'

Response samples

application/json

{"apiversion": 3,
"func": "get_information_for_applications",
"module": "Branding",
"result": {"data": {"property1": {"condition": {"feature": "blockers",
"if": "!$isarchiveuser",
"module": "string"
},
"description": "Email Filters",
"icon": {"height": 32,
"url": "email_filters",
"width": 35
},
"implements": "Email_UserLevelFiltering",
"key": "email_filters",
"name": "Email Filters",
"order": 4,
"terms": ["email",
"filter",
"filters"
],
"type": "item",
"url": "mail/filters/userfilters.html"
},
"property2": {"condition": {"feature": "blockers",
"if": "!$isarchiveuser",
"module": "string"
},
"description": "Email Filters",
"icon": {"height": 32,
"url": "email_filters",
"width": 35
},
"implements": "Email_UserLevelFiltering",
"key": "email_filters",
"name": "Email Filters",
"order": 4,
"terms": ["email",
"filter",
"filters"
],
"type": "item",
"url": "mail/filters/userfilters.html"
}
},
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}