WHM API.
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/
https://{host}:{port}/json-api/
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/delete_ssl_vhost
- A server running WHM.
https://whm-server.tld:2087/json-api/delete_ssl_vhost
- 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/delete_ssl_vhost?host=example.com'{ "data": { "output": [ … ], "removed_vhost_data": [ … ] }, "metadata": { "command": "delete_ssl_vhost", "reason": "OK", "result": 1, "version": 1 } }
Request
This function adds SSL certificates to the installation queue. This allows you to defer and batch SSL certificate installation.
Important:
You must enter the same quantity of username, cab, crt, key, and vhost_name parameters. For example, to add three certificates to the installation queue, enter the username parameter three times, then enter three cab, crt, key, and vhost_name parameters.
The Certificate Authority (CA) bundle's contents.
Note:
- We recommend that you enter an empty string. An empty string tells the server to download the CA bundle automatically.
- To add multiple certificates to the installation queue, duplicate or increment the parameter name. For example,
cab-1,cab-2, andcab-3.
The certificate's contents.
Note:
To add multiple certificates to the installation queue, duplicate or increment the parameter name. For example, crt-1, crt-2, and crt-3.
The private key's text.
Note:
To add multiple certificates to the installation queue, duplicate or increment the parameter name. For example, key-1, key-2, and key-2.
The cPanel account username for which to enqueue the SSL certificate installations.
Note:
To add multiple certificates to the installation queue, duplicate or increment the parameter name. For example, username-1, username-2, and username-3.
The name of the web virtual host (vhost) for which to install the certificate.
Note:
To add multiple certificates to the installation queue, duplicate or increment the parameter name. For example, vhost_name-1, vhost_name-2, and vhost_name-3.
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/enqueue_deferred_ssl_installations
- A server running WHM.
https://whm-server.tld:2087/json-api/enqueue_deferred_ssl_installations
- 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/enqueue_deferred_ssl_installations?cab=string&crt=string&key=string&username=string&vhost_name=string'{ "data": {}, "metadata": { "command": "enqueue_deferred_ssl_installations", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/fetch_ssl_certificates_for_fqdns
- A server running WHM.
https://whm-server.tld:2087/json-api/fetch_ssl_certificates_for_fqdns
- 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/fetch_ssl_certificates_for_fqdns?domains=string'{ "data": { "payload": [ … ] }, "metadata": { "command": "fetch_ssl_certificates_for_fqdns", "reason": "OK", "result": 1, "version": 1 } }