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/get_autossl_user_excluded_domains
- A server running WHM.
https://whm-server.tld:2087/json-api/get_autossl_user_excluded_domains
- 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/get_autossl_user_excluded_domains?username=example'Response
application/json
{ "data": { "payload": [ … ] }, "metadata": { "command": "get_autossl_user_excluded_domains", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/remove_autossl_user_excluded_domains
- A server running WHM.
https://whm-server.tld:2087/json-api/remove_autossl_user_excluded_domains
- 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/remove_autossl_user_excluded_domains?domain=cpcalendars.example.com&username=username'Response
application/json
{ "metadata": { "command": "remove_autossl_user_excluded_domains", "reason": "OK", "result": 1, "version": 1 } }
Query
Additional parameters which you wish to pass to the AutoSSL provider.
Note:
These additional parameters begin with the x_ prefix. For example, the Let's Encrypt provider accepts the x_terms_of_service_accepted parameter, to which you would pass the URL of the terms of service that you accept.
Example: x_*=(varies)
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/reset_autossl_provider
- A server running WHM.
https://whm-server.tld:2087/json-api/reset_autossl_provider
- 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/reset_autossl_provider?provider=cPanel&x_*=%28varies%29'Response
application/json
{ "metadata": { "command": "reset_autossl_provider", "reason": "OK", "result": 1, "version": 1 } }