WHM API.
Download OpenAPI description
Overview
URL
WebPros International, LLC
License
Languages
Servers
Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/
A server running WHM.
https://{host}:{port}/json-api/
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/set_cpanel_updates
- A server running WHM.
https://whm-server.tld:2087/json-api/set_cpanel_updates
- 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/set_cpanel_updates?updates=daily'Response
application/json
{ "data": { "updates": "daily" }, "metadata": { "command": "set_cpanel_updates", "reason": "Cpanel update frequency set to daily", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/set_tier
- A server running WHM.
https://whm-server.tld:2087/json-api/set_tier
- 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/set_tier?tier=current'Response
application/json
{ "data": { "tier": "current" }, "metadata": { "command": "set_tier", "reason": "Update tier successfully changed to current", "result": 1, "version": 1 } }
Query
The cPanel & WHM update’s mode of operation.
- null — Only reinstall cPanel & WHM if a newer version is available.
force— Force a reinstall of cPanel & WHM, even if the system is up to date.sync— Update the currently-installed version of cPanel & WHM instead of downloading a newer version. This ensures the current version installed has the correct files.
Default null
Enum"force""sync"
Example: mode=force
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/start_cpanel_update
- A server running WHM.
https://whm-server.tld:2087/json-api/start_cpanel_update
- 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/start_cpanel_update?mode=force'Response
application/json
{ "data": { "is_new": 1, "log_path": "/var/cpanel/updatelogs/update.1604521159.log", "pid": 23456 }, "metadata": { "command": "start_cpanel_update", "reason": "OK", "result": 1, "version": 1 } }