SSL Certificates

URL:
https://<root>/machines/<machine>/sslcertificates
Methods:
GET
Required Capability:
Access allowed with any authorized privilege
Version Introduced:
10.1

Description

The sslcertificates resource lists all the certificates (self-signed and CA-signed) created for a server machine. The server securely stores these certificates inside a key store within the configuration store.

Before you enable SSL on your server, you need to generate certificates and get them signed by a trusted certificate authority (CA). For your convenience, the server is capable of generating self-signed certificates that can be used during development or staging. However, it is critical that you get CA-signed certificates when standing up a production server. In order 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 CA signed certificate operation.

Request parameters

ParameterDescription

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample request URL used to access the sslCertificates resource:

Use dark colors for code blocksCopy
1
https://machine.domain.com/webadaptor/admin/machines/MACHINE.DOMAIN.COM/sslcertificates?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
5
6
{
  "certificates": [
    "<certificate1>",
    "<certificate2>"
  ]
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
{
   "certificates": [
     "selfsignedcertificate",
     "myproductioncertificate"
   ]
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.