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 verifies the connection from the cPanel Customer Portal to the server.
Note:
This function is not available through the command line. You must call it as a request body.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/ticket_ssh_test
- A server running WHM.
https://whm-server.tld:2087/json-api/ticket_ssh_test
- 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/ticket_ssh_test?server_num=2&ticket_id=999999999'Response
application/json
{ "data": { "non_fatals": [ … ], "result": "SUCCESS" }, "metadata": { "command": "ticket_ssh_test", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/ticket_ssh_test_start
- A server running WHM.
https://whm-server.tld:2087/json-api/ticket_ssh_test_start
- 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/ticket_ssh_test_start?server_num=1&ticket_id=7648492'Response
application/json
{ "data": {}, "metadata": { "command": "ticket_ssh_test_start", "reason": "OK", "result": 1, "version": 1 } }
Request
This function checks whether the server's firewall whitelist correlates with the granted support tickets. You can view granted support tickets in WHM's Grant cPanel Support Access interface (WHM >> Home >> Support >> Grant cPanel Support Access).
Note:
This function is not available through the command line. You must call it as a request body.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/ticket_whitelist_check
- A server running WHM.
https://whm-server.tld:2087/json-api/ticket_whitelist_check
- 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/ticket_whitelist_checkResponse
application/json
{ "data": { "chain_status": "ACTIVE", "problem": "NO" }, "metadata": { "command": "ticket_whitelist_check", "reason": "OK", "result": 1, "version": 1 } }