Delete customization data

This function deletes customization data.

Customization data includes brand logos and colors.

Server owners and resellers can supply customization data to whitelabel portions of the product or customize the cPanel experience for their users.

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

If you provide the optional path parameter, the API will removed only the specific element specified in the . separated path. See the parameter for more details.

SecurityBasicAuth
Request
query Parameters
application
required
string

The application name for the customization.

Example: application=cpanel
theme
required
string

The theme name for the customization.

Example: theme=jupiter
path
string

The JSONPath expression to reach to property you want to delete. We support only the subset of JSONPath using the . style notation. There is presently no other JSONPath features supported.

Example: path=brand.icon.description
Responses
200

HTTP Request was successful.

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