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/
Query Examples:
Disable AutoSSL for this domain.
Note:
To disable AutoSSL for multiple domains, increment the parameter name. For example, domain=example.com, domain-1=example1.com, and domain-2=example.com.
Disable AutoSSL for multiple domains.
Disable AutoSSL for a single domain.
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/add_autossl_user_excluded_domains
- A server running WHM.
https://whm-server.tld:2087/json-api/add_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/add_autossl_user_excluded_domains?domain=string&username=example'Response
application/json
{ "metadata": { "command": "add_autossl_user_excluded_domains", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/disable_autossl
- A server running WHM.
https://whm-server.tld:2087/json-api/disable_autossl
- 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/disable_autosslResponse
application/json
{ "metadata": { "command": "disable_autossl", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_autossl_check_schedule
- A server running WHM.
https://whm-server.tld:2087/json-api/get_autossl_check_schedule
- 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_check_scheduleResponse
application/json
{ "data": { "cron": [ … ], "next_time": "2016-06-09T06:00:00.000Z" }, "metadata": { "command": "get_autossl_check_schedule", "reason": "OK", "result": 1, "version": 1 } }