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 removes a cPanel Customer Portal SSH key from 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_revoke
- A server running WHM.
https://whm-server.tld:2087/json-api/ticket_revoke
- 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_revoke?server_num=1&ssh_username=username&ticket_id=999999999'Response
application/json
{ "data": { "chain_status": "ACTIVE", "csf_wl_status": "ACTIVE", "host_access_wl_status": "ACTIVE", "hulk_wl_status": "ACTIVE", "non_fatals": [], "revoked_keys": 1, "server_num": 2, "ssh_username": "username", "ticket_id": 999999999 }, "metadata": { "command": "ticket_revoke", "reason": "OK", "result": 1, "version": 1 } }
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 } }