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_is_active
- A server running WHM.
https://whm-server.tld:2087/json-api/restore_queue_is_active
- 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_is_activeResponse
application/json
{ "data": { "is_active": 1 }, "metadata": { "command": "restore_queue_is_active", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/restore_queue_list_active
- A server running WHM.
https://whm-server.tld:2087/json-api/restore_queue_list_active
- 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_activeResponse
application/json
{ "data": { "restore_job": [ … ] }, "metadata": { "command": "restore_queue_list_active", "reason": "OK", "result": 1, "version": 1 } }
Request
This function lists the restoration queue's completed tasks.
Important:
This function's output varies dramatically. The /usr/local/cpanel/bin/backup_restore_manager script run with the list_finished option determines this output..
Note:
On servers that run CentOS 7, you may see a named warning about the absence of SPF resource records on DNS.
- This warning is not relevant on CentOS 7 servers, because RFC 7208 deprecated SPF records. CentOS 7 servers use TXT records instead of SPF records.
- Red Hat 7.1 and CentOS 7.1 both contain
bind-9.9.4-23.el7, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the Red Hat Bugzilla case about SPF record errors.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/restore_queue_list_completed
- A server running WHM.
https://whm-server.tld:2087/json-api/restore_queue_list_completed
- 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_completedResponse
application/json
A task that the restore_queue_add_task function added.
{ "data": { "restore_job": [ … ] }, "metadata": { "command": "restore_queue_list_completed", "reason": "OK", "result": 1, "version": 1 } }