MethodPathDescription
GET/v1/cluster/certificatesGet 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

KeyValueDescription
Hostcnm.cluster.fqdnDomain name
Acceptapplication/jsonAccepted 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

CodeDescription
200 OKNo 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. See the certificates table for the list of cluster certificates and their descriptions.

Request

Example HTTP request

DELETE /cluster/certificates/<certificate_name>

Request headers

KeyValueDescription
Hostcnm.cluster.fqdnDomain name
Acceptapplication/jsonAccepted media type

Response

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

Status codes

CodeDescription
200 OKOperation successful
404 Not FoundFailed, requested deletion of an unknown certificate
403 ForbiddenFailed, requested deletion of a required certificate
500 Internal Server ErrorFailed, error while deleting certificate from disk