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/list_linked_server_nodes
- A server running WHM.
https://whm-server.tld:2087/json-api/list_linked_server_nodes
- 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/list_linked_server_nodesResponse
application/json
{ "data": { "payload": [ … ] }, "metadata": { "command": "list_linked_server_nodes", "reason": "OK", "result": 1, "version": 1 } }
Request
This function returns the system's cPanel accounts and the linked cPanel & WHM server on which they exist.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/list_user_child_nodes
- A server running WHM.
https://whm-server.tld:2087/json-api/list_user_child_nodes
- 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/list_user_child_nodesResponse
application/json
{ "data": { "payload": [ … ] }, "metadata": { "command": "list_user_child_nodes", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/unlink_server_node
- A server running WHM.
https://whm-server.tld:2087/json-api/unlink_server_node
- 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/unlink_server_node?alias=example&handle_api_token=expire_24h'Response
application/json
{ "data": { "alias": "example", "enabled_services": [ … ], "hostname": "example.com", "last_check": 1556576165, "system_settings": { … }, "tls_verified": 1, "username": "root", "version": "11.86.0.0", "worker_capabilities": { … } }, "metadata": { "command": "unlink_server_node", "reason": "OK", "result": 1, "version": 1 } }