Retrieve customization data

This function retrieves customization data.

Customization data includes brand logos and colors.

This function is used to retrieve customization data for the Jupiter theme only. To retrieve customization data for cPanel Paper Lantern users, use the Customization (WHM >> cPanel >> Customization) interface.

SecurityBasicAuth
Request
query Parameters
application
required
string

The application name for the customization.

Example: application=cpanel
theme
required
string

The theme for the customization.

Example: theme=jupiter
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
get/retrieve_customizations
Request samples
whmapi1 --output=jsonpretty \
  retrieve_customizations \
  application='cpanel' \
  theme='jupiter'
Response samples
application/json
{
  • "metadata": {
    • "command": "retrieve_customizations",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}