Platform - Configuration - TLS

Get TLS certificate

Retrieves a certificate in the TLS certificate chain.

Request

GET /api/v1/platform/configuration/security/tls/{service_name}

Path parameters

Name Type Required Description

service_name

string; allowed values: [adminconsole, proxy, ui]

Y

The service certificate chain to read.

Responses

200
(TlsPublicCertChain) The TLS certificate chain, with private key omitted, for the given service and whether it was user specified
Warning

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XGET {{hostname}}/api/v1/platform/configuration/security/tls/{service_name} \
-u $CLOUD_USER:$CLOUD_KEY

Set TLS certificate

Creates or updates the TLS certificate chain.

Request

POST /api/v1/platform/configuration/security/tls/{service_name}

Path parameters

Name Type Required Description

service_name

string; allowed values: [adminconsole, proxy, ui]

Y

The service certificate chain to read.

Request body

(string) (required) New certificate chain: the PEM encoded RSA private key, followed by the server certificate, followed by the CA certificate

Responses

202
(EmptyResponse) The TLS update has been accepted for the given service and will take effect throughout the system
449
(BasicFailedReply) elevated permissions are required. (code: '"root.needs_elevated_permissions"')
Warning

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/platform/configuration/security/tls/{service_name} \
-u $CLOUD_USER:$CLOUD_KEY