List cluster backups

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

• CLUSTER_ADMIN
• CLUSTER_OPERATOR_WRITER
• AUDITOR

GET /api/v1/clusters/{cluster_id}/backups

cURL

cURL

curl --request GET \
  --url 'https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/backups?pagination.page=SOME_STRING_VALUE&pagination.limit=SOME_INTEGER_VALUE&pagination.as_of_time=SOME_STRING_VALUE&pagination.sort_order=SOME_STRING_VALUE&start_time=SOME_STRING_VALUE&end_time=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

200

{
  "backups": [
    {
      "as_of_time": "2023-11-07T05:31:56Z",
      "id": "<string>"
    }
  ],
  "pagination": {
    "next_page": "<string>",
    "previous_page": "<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

The cluster associated with the backups being retrieved.

Query Parameters

pagination.page · string

pagination.limit · integer<int32>

pagination.as_of_time · string<date-time>

pagination.sort_order · enum<string>

• ASC: Sort in ascending order. This is the default unless otherwise specified.
• DESC: Sort in descending order.

Available options: ASC, DESC

start_time · string<date-time>

The beginning of the time range (inclusive) used to search for backups.

end_time · string<date-time>

The end of the time range (exclusive) used to search for backups.

Response

200

application/json

A successful response.

backups · object[] · required

Show child attributes

pagination · object

Show child attributes