Method Path Description
GET /v1/cluster/certificates Get cluster certificates
DELETE /v1/cluster/certificates/{certificate_name} Delete cluster certificate

Get cluster certificates

GET /v1/cluster/certificates

Get the cluster’s certificates.

Required permissions

Permission name
view_cluster_info

Request

Example HTTP request

GET /cluster/certificates 

Request headers

Key Value Description
Host cnm.cluster.fqdn Domain name
Accept application/json Accepted media type

Response

Returns a JSON object that contains the cluster’s certificates and keys.

Example JSON body

{
    "api_cert": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
    "api_key": "-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY-----"
    "// additional certificates..."
}

Status codes

Code Description
200 OK No error

Delete cluster certificate

DELETE /v1/cluster/certificates/{string: certificate_name}

Removes the specified cluster certificate from both CCS and disk across all nodes. Only optional certificates can be deleted through this endpoint.

Request

Example HTTP request

DELETE /cluster/certificates/<certificate_name>

Request headers

Key Value Description
Host cnm.cluster.fqdn Domain name
Accept application/json Accepted media type

Response

Returns a status code that indicates the certificate deletion success or failure.

Status codes

Code Description
200 OK Operation successful
404 Not Found Failed, requested deletion of an unknown certificate
403 Forbidden Failed, requested deletion of a required certificate
500 Internal Server Error Failed, error while deleting certificate from disk