Update disruption specifications for a cluster

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

• CLUSTER_ADMIN
• CLUSTER_OPERATOR_WRITER

PUT /api/v1/clusters/{cluster_id}/disrupt

cURL

cURL

curl --request PUT \
  --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/disrupt \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --json '{"regional_disruptor_specifications":[{"azs":["string"],"is_whole_region":true,"pods":["string"],"region_code":"string"}]}'

200

{
  "regional_disruptor_specifications": [
    {
      "is_whole_region": true,
      "region_code": "<string>",
      "azs": [
        "<string>"
      ],
      "pods": [
        "<string>"
      ]
    }
  ]
}

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

This endpoint is in Limited Access and may not be available to all users. Refer to the API support policy for more details.

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

cluster_id specifies the cluster for this request.

Body

application/json

regional_disruptor_specifications · object[]

regional_disruptor_specifications specify how regions are to be disrupted. Any Cluster region that is not specified here will not be disrupted. A cluster region that was previously disrupted but is not listed here will be removed from disruption. To stop all disruptions, set this to an empty list or omit it from the request.

Show child attributes

Response

200

application/json

A successful response.

regional_disruptor_specifications · object[] · required

regional_disruptor_specifications represents a region that is disrupted. If there are no entries, it means the cluster is not disrupted.

Show child attributes