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_list_pending
- A server running WHM.
https://whm-server.tld:2087/json-api/restore_queue_list_pending
- 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_list_pendingResponse
application/json
{ "data": { "restore_job": [ … ] }, "metadata": { "command": "restore_queue_list_pending", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/restore_queue_state
- A server running WHM.
https://whm-server.tld:2087/json-api/restore_queue_state
- 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_stateHTTP Request was successful.
Example: {"active":[{"options":{"give_ip":1,"mail_config":1,"mysql":1,"subdomains":1},"restore_point":"2019-10-21T00:00:00.000Z","user":"username"}],"completed":[{"options":{"give_ip":1,"mail_config":0,"mysql":1,"subdomains":0},"restore_point":"2019-10-22T00:00:00.000Z","user":"username"}],"is_active":1,"pending":[{"options":{"give_ip":0,"mail_config":1,"mysql":0,"subdomains":1},"restore_point":"2019-10-23T00:00:00.000Z","user":"username"}]}
Response
application/json
{ "data": { "active": [ … ], "completed": [ … ], "is_active": 1, "pending": [ … ] }, "metadata": { "command": "restore_queue_state", "reason": "OK", "result": 1, "version": 1 } }