- URL:https://<machine-url>/sslCertificates
- Operations:Generate Certificate, Import Existing Server Certificate, Import Root or Intermediate Certificate, Update Web Server Certificate
- Child Resources:SSL Certificate
- Required Capability:Default administrator role | Security and infrastructure privilege
- Version Introduced:10.8
Description
This resource lists all the certificates (self-signed and CA-signed) created for the portal machine as well as the certificates currently configured with the portal. This resource also provides access to operations that can be used to manage SSL certificates in a highly available portal.
Before you enable SSL on your portal, you need to generate certificates and get them signed by a trusted certificate authority (CA). For your convenience, the portal is capable of generating self-signed certificates that can be used during development or staging. However, it is critical that you obtain CA-signed certificates when standing up a production server.
To get a certificate signed by a CA, you need to generate a CSR (certificate signing request) and then submit it to your CA. The CA will sign your certificate request, which can then be imported into the server by using the Import Signed Certificate operation. The portal securely stores self-signed, CA-signed, and configured certificates inside a key store.
Request parameters
Parameter | Details |
---|---|
f | The response format. The default response value is html. Values: html | json | pjson |
Example usage
Below is a sample request URL for the sslCertificates resource:
https://machine.domain.com/webadaptor/portaladmin/machines/MACHINE.DOMAIN.COM/sslCertificates?f=json
JSON Response syntax
{
"sslCertificates": [
"<certificate1>",
"<certificate2>",
...
],
"webServerCertificateAlias": "<certificate>"
}
JSON Response example
{
"sslCertificates": [
"portal",
"myproductioncertificate"
],
"webServerCertificateAlias": "portal"
}