WHM API.
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/
https://{host}:{port}/json-api/
Request
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.
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.
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/delete_customizations
- A server running WHM.
https://whm-server.tld:2087/json-api/delete_customizations
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/delete_customizations?application=cpanel&theme=jupiter&path=brand.icon.description'{ "metadata": { "command": "delete_customizations", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/retrieve_customizations
- A server running WHM.
https://whm-server.tld:2087/json-api/retrieve_customizations
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/retrieve_customizations?application=cpanel&theme=jupiter'{ "metadata": { "command": "retrieve_customizations", "reason": "OK", "result": 1, "version": 1 } }
The application name for the customization.
The theme data to save.
The customization data.
Optional documentation information.
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/update_customizations
- A server running WHM.
https://whm-server.tld:2087/json-api/update_customizations
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/update_customizations?application=cpanel&data={%22brand%22%3A{%22colors%22%3A{%22accent%22%3A%22%2300FF00%22%2C%22primary%22%3A%22%23961218%22}%2C%22favicon%22%3A%22AAABAAEAICACAAEAAQAwAQAAFgAAACgAAAAgAAAAQAAAAAEAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACanZoAAAAAAP%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FAD%2F%2F%2BAg%2F%2F%2FAEH%2F%2FgDB%2F%2F4AQf%2F%2BAuCq%2FAfAgBwP4IA8H%2BBABA%2FgQAwH8EAGArA%2FAgAQPwMACD%2BDAAAfA%2BAIPwP1UBQH%2F%2FgAB%2F%2F8AAf%2F%2FgAP%2F%2FwAH%2F%2F%2BiP%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8AP%2F%2F4CD%2F%2F8AQf%2F%2BAMH%2F%2FgBB%2F%2F4C4Kr8B8CAHA%2FggDwf4EAED%2BBADAfwQAYCsD8CABA%2FAwAIP4MAAB8D4Ag%2FA%2FVQFAf%2F%2BAAH%2F%2FwAB%2F%2F%2BAA%2F%2F%2FAAf%2F%2F6I%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8&theme=jupiter'{ "metadata": { "command": "update_customizations", "reason": "OK", "result": 1, "version": 1 } }