Get the version upgrade deferral policy for a cluster.

cURL

curl --request GET \
  --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/version-deferral \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

{
  "deferral_policy": "FIXED_DEFERRAL"
}

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

GET

api

clusters

{cluster_id}

version-deferral

cURL

curl --request GET \
  --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/version-deferral \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

{
  "deferral_policy": "FIXED_DEFERRAL"
}

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

This endpoint is in Preview and subject to change. 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

Response

A successful response.

ClusterVersionDeferral specifies whether automatic patch version upgrades are applied immediately or deferred. If upgrades are deferred, the cluster will be automatically upgraded to each patch version 60 days after the version is released to CockroachDB Cloud.

deferral_policy

enum<string>

required

Available options:

NOT_DEFERRED,

FIXED_DEFERRAL

Update a SQL user's password Set the version upgrade deferral policy for a cluster

Overview

Endpoints

Get the version upgrade deferral policy for a cluster.

Authorizations

Path Parameters

Response