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
The AutoSSL provider's name. For example:
cPanelLetsEncrypt
Example: provider=cPanel
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/set_autossl_provider
- A server running WHM.
https://whm-server.tld:2087/json-api/set_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/set_autossl_provider?provider=cPanel&x_*=%28varies%29'Response
application/json
{ "metadata": { "command": "set_autossl_provider", "reason": "OK", "result": 1, "version": 1 } }
Query Examples:
Disable AutoSSL for this domain. If you do not include this parameter, the system will enable AutoSSL for every domain on the account.
Note
To disable AutoSSL for multiple domains, duplicate or increment the parameter name. For example, to exclude three domains, you could:
- Use the
domainparameter multiple times. - Use the
domain,domain-1, anddomain-2parameters.
domain=domain=example.com&domain-1=example1.com&domain-2=example2.com
domain=domain=example.com&domain=example1.com&domain=example2.com
domain=example.com
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/set_autossl_user_excluded_domains
- A server running WHM.
https://whm-server.tld:2087/json-api/set_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/set_autossl_user_excluded_domains?username=example&domain=cpcalendars.example.com'Response
application/json
{ "metadata": { "command": "set_autossl_user_excluded_domains", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/start_autossl_check_for_all_users
- A server running WHM.
https://whm-server.tld:2087/json-api/start_autossl_check_for_all_users
- 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/start_autossl_check_for_all_usersResponse
application/json
{ "data": { "pid": 29193 }, "metadata": { "command": "start_autossl_check_for_all_users", "reason": "OK", "result": 1, "version": 1 } }