Install SSL certificate
This function installs an SSL certificate.
Note:
Due to their inherent complexities, SSL-related functions often present problems for third-party developers. For the additional steps required to successfully call this function, read our Call UAPI's SSL::install_ssl Function in Custom Code documentation.
Important:
When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.
Query parameters
The certificate to install.
Note:
-
You must URI-encode this value.
-
You can use a Perl command to URI-encode your SSL certificate for this parameter. For example, you can use the following string, where CERT.FILE is the SSL certificate file:
$(perl -MURI::Escape -ne 'print uri_escape($_);' CERT.FILE)
The domain name.
The Certificate Authority (CA) bundle data, if the certificate requires it.
Note:
-
You must URI-encode this value.
-
You can use a Perl command to URI-encode your SSL certificate for this parameter. For example, you can use the following string, where CABUNDLE.FILE is the SSL certificate file:
$(perl -MURI::Escape -ne 'print uri_escape($_);' CABUNDLE.FILE)
A map of each domain to its domain control validation (DCV) method.
{
"example.com": "http"
}The certificate's key. If you omit it, the system uses the matching key already saved to your account.
Note:
-
You must URI-encode this value.
-
You can use a Perl command to URI-encode your SSL certificate for this parameter. For example, you can use the following string, where KEY.FILE is the SSL certificate file:
$(perl -MURI::Escape -ne 'print uri_escape($_);' KEY.FILE)
The cPanel Store order item ID associated with the certificate.
The cPanel Store certificate ID that this certificate descends from. The short-lived certificate re-issue workflow sets this so the system can supersede the prior certificate after installation; end users do not normally set it.
The expiration of the parent subscription certificate, as a Unix timestamp.
The virtual host names onto which to install the certificate. To set multiple names, duplicate or increment the parameter name. For example, vhost_names-1 and vhost_names-2.
[ "example.com" ]
Response
HTTP Request was successful.
Example response
{
"apiversion": 3,
"func": "install_ssl",
"module": "SSL",
"result": {
"data": {
"action": "update",
"cert_id": "example_com_bbe7e_16e2d_1369007999_1d87a0cdb540f5aae607b10e9a1a82fb",
"domain": "example.com",
"extra_certificate_domains": [
"ssl.example.com"
],
"html": "The SSL certificate is now installed onto the domain \"example.com\" using the IP address \"192.168.0.1\".\nThe existing virtual host was updated with the new certificate. Apache is restarting in the background.",
"key_id": "bbe7e_16e2d_df7539f280eb1ecf6c1096190e41ada7",
"message": "The SSL certificate is now installed onto the domain \"example.com\" using the IP address \"192.168.0.1\".\nThe existing virtual host was updated with the new certificate.\nApache is restarting in the background.",
"statusmsg": "The SSL certificate is now installed onto the domain \"example.com\" using the IP address \"192.168.0.1\".\nThe existing virtual host was updated with the new certificate.\nApache is restarting in the background.\nThe SSL certificate is now installed onto the domain \"example.com\" using the IP address \"192.168.0.1\".\nThe existing virtual host was updated with the new certificate.\nApache is restarting in the background",
"user": "example",
"warning_domains": [
"warning.com"
],
"working_domains": [
"example.com"
]
},
"metadata": {
"transformed": 1
},
"status": 1
}
}