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/purchase_a_license
- A server running WHM.
https://whm-server.tld:2087/json-api/purchase_a_license
- 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/purchase_a_license?login_token=1a676e6f-99fc-11e6-9ab6-e60a769b73bc&provider=cPStore&url_after_checkout=http%3A%2F%2Fhostname.example.com&upgrade=1'Response
application/json
{ "data": { "payload": [ … ] }, "metadata": { "command": "purchase_a_license", "reason": "OK", "result": 1, "version": 1 } }
Request
This function verifies the system's license status with WebPros International, LLC's licensing servers. To do this, the function runs the /usr/local/cpanel/cpkeyclt script.
For more information about this script and potential license problems, read our Installation Guide - Troubleshoot Your Installation documentation.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/run_cpkeyclt
- A server running WHM.
https://whm-server.tld:2087/json-api/run_cpkeyclt
- 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/run_cpkeycltResponse
application/json
{ "metadata": { "command": "run_cpkeyclt", "reason": "OK", "result": 1, "version": 1 } }