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/restore_queue_activate
- A server running WHM.
https://whm-server.tld:2087/json-api/restore_queue_activate
- 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/restore_queue_activateResponse
application/json
{ "metadata": { "command": "restore_queue_activate", "reason": "Restore queue processing initiated", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/restore_queue_clear_all_completed_tasks
- A server running WHM.
https://whm-server.tld:2087/json-api/restore_queue_clear_all_completed_tasks
- 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/restore_queue_clear_all_completed_tasksResponse
application/json
{ "metadata": { "command": "restore_queue_clear_all_completed_tasks", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/restore_queue_clear_all_failed_tasks
- A server running WHM.
https://whm-server.tld:2087/json-api/restore_queue_clear_all_failed_tasks
- 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/restore_queue_clear_all_failed_tasksResponse
application/json
{ "metadata": { "command": "restore_queue_clear_all_failed_tasks", "reason": "OK", "result": 1, "version": 1 } }