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/
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
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
whmapi1 --output=jsonpretty \
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
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
whmapi1 --output=jsonpretty \
unlink_server_node \
alias='example'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 } }
Request
This function updates a linked remote cPanel server node.
Important:
This function requires the use of an API token. For more information, read our Guide to API Authentication - API Tokens in WHM documentation.
Security
BasicAuth
Query
The API token required to make API calls to the remote cPanel server node.
This value defaults to the existing API token.
Note:
The API token must have root-level access on the remote cPanel server node.
Example: api_token=23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H
A new remote cPanel server node's hostname. The system will update your remote cPanel server node's hostname to this value.
This value defaults to the existing hostname.
Note:
This parameter does not accept an IP address.
Example: hostname=example.com
Whether to skip SSL/TLS verification. The system performs this action when it queries the remote cPanel server node.
Note:
If the remote cPanel server is SSL/TLS verified, you cannot skip verification.
Default 1
Enum01
Example: skip_tls_verification=0
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/update_linked_server_node
- A server running WHM.
https://whm-server.tld:2087/json-api/update_linked_server_node
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
whmapi1 --output=jsonpretty \
update_linked_server_node \
alias='example'Response
application/json
{ "metadata": { "command": "update_linked_server_node", "reason": "OK", "result": 1, "version": 1 } }