Set Client CA Cert for a cluster

Can be used by the following roles assigned at the organization, folder or cluster scope:

• CLUSTER_ADMIN
• CLUSTER_OPERATOR_WRITER

POST /api/v1/clusters/{cluster_id}/client-ca-cert

cURL

cURL

curl --request POST \
  --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/client-ca-cert \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "x509_pem_cert": "-----BEGIN CERTIFICATE-----..."
}
'

200

{
  "x509_pem_cert": "<string>"
}

{
  "code": 123,
  "details": [
    {
      "@type": "<string>"
    }
  ],
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

cluster_id · string · required

Body

application/json

x509_pem_cert · string · required

Response

200

application/json

A successful response.

status · enum<string>

• NOT_SET: NOT_SET indicates a client CA cert is not set on the cluster. New clusters won't have a client CA cert set.
• IS_SET: IS_SET indicates a client CA cert is set on the cluster.
• PENDING: PENDING indicates a client CA cert update is in flight on the cluster.
• FAILED: FAILED indicates a client CA cert update was attempted, but failed.

Available options: NOT_SET, IS_SET, PENDING, FAILED

x509_pem_cert · string