Get a blackout window by its ID for a cluster

cURL

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

{
  "cluster_id": "12345678-1234-1234-1234-123456789012",
  "end_time": "2025-10-15T06:00:00Z",
  "id": "12345678-1234-1234-1234-123456789012",
  "start_time": "2025-10-15T00:00:00Z"
}

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

GET

api

clusters

{cluster_id}

blackout-windows

{blackout_window_id}

cURL

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

{
  "cluster_id": "12345678-1234-1234-1234-123456789012",
  "end_time": "2025-10-15T06:00:00Z",
  "id": "12345678-1234-1234-1234-123456789012",
  "start_time": "2025-10-15T00:00:00Z"
}

{
  "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

blackout_window_id

string

required

Response

A successful response.

BlackoutWindow schedules a period of up to 14 days for an ADVANCED cluster to block "high-risk" operations that impact SQL availability or require CRDB pod restarts.

cluster_id

string

required

The cluster ID that this blackout window applies to.

end_time

string<date-time>

required

The end time of the blackout window (UTC). Can be up to 14 days after the start time. Must not be more than three months after the current time.

string

required

The unique ID of the blackout window.

start_time

string<date-time>

required

The start time of the blackout window (UTC). Must be scheduled at least 7 days in advance.

Create a blackout window for a cluster Delete a blackout window for a cluster