Skip to main content
PUT
cURL
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

Body

application/json
​
deferral_policy
enum<string>
required
  • NOT_DEFERRED: automatic patch version upgrades are applied immediately after release.
  • DEFERRAL_60_DAYS: automatic patch version upgrades are applied in a maintenance window at least 60 days after the patch version release date.
  • FIXED_DEFERRAL: Deprecated: FIXED_DEFERRAL is equivalent to DEFERRAL_60_DAYS. It will be removed in a future version.
  • DEFERRAL_30_DAYS: automatic patch version upgrades are applied in a maintenance window at least 30 days after the patch version release date.
  • DEFERRAL_90_DAYS: automatic patch version upgrades are applied in a maintenance window at least 90 days after the patch version release date.
Available options:
NOT_DEFERRED,
DEFERRAL_60_DAYS,
FIXED_DEFERRAL,
DEFERRAL_30_DAYS,
DEFERRAL_90_DAYS
​
deferred_until
string<date-time>

Deprecated: This field is ignored and will be removed in a future version.

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 after the specified number of days (30, 60, or 90) after the version is released to CockroachDB Cloud.

​
deferral_policy
enum<string>
required
  • NOT_DEFERRED: automatic patch version upgrades are applied immediately after release.
  • DEFERRAL_60_DAYS: automatic patch version upgrades are applied in a maintenance window at least 60 days after the patch version release date.
  • FIXED_DEFERRAL: Deprecated: FIXED_DEFERRAL is equivalent to DEFERRAL_60_DAYS. It will be removed in a future version.
  • DEFERRAL_30_DAYS: automatic patch version upgrades are applied in a maintenance window at least 30 days after the patch version release date.
  • DEFERRAL_90_DAYS: automatic patch version upgrades are applied in a maintenance window at least 90 days after the patch version release date.
Available options:
NOT_DEFERRED,
DEFERRAL_60_DAYS,
FIXED_DEFERRAL,
DEFERRAL_30_DAYS,
DEFERRAL_90_DAYS
​
deferred_until
string<date-time>