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 links your server to a remote server node. The server uses an API token to communicate with the remote server node.
Important:
- This function only runs on a Standard Node profile server.
- The remote server node must use a version that is the same as or greater than your server version.
- 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
A unique name that refers to the remote server node.
Note:
The alias may only contain alphanumeric characters, dashes (-), and underscores (_). It also has a maximum length of 50 characters.
Example: alias=example
The API token required to make API calls to the remote server node.
Note:
The API token must have root-level access on the remote server node.
Example: api_token=23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H
The remote server node's hostname.
Note:
This parameter does not accept an IP address.
Example: hostname=host.example.com
The username required to make API calls to the remote server node.
Note:
The username must have root-level access on the remote server node.
Example: username=root
Whether to skip SSL/TLS verification. The system performs this action when it queries the remote server node.
Default 0
Enum10
Example: skip_tls_verification=0
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/link_server_node_with_api_token
- A server running WHM.
https://whm-server.tld:2087/json-api/link_server_node_with_api_token
- 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/link_server_node_with_api_token?alias=example&api_token=23ZX8RA1FTE1IVJRL90MB5CREDS4UE2H&hostname=host.example.com&username=root&skip_tls_verification=0'Response
application/json
{ "metadata": { "command": "link_server_node_with_api_token", "reason": "OK", "result": 1, "version": 1 } }
- 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 } }