Sign in

v1

latestOpenAPI 3.0.22026-08-062794201004.1 KB
Cloud Snapshot Backups & Restore

List Cloud Snapshot Backups at the Project Level

Lists cloud snapshot backups associated with operational clusters within a specific project.

The "most recent" and "oldest" backup fields do not include backups that are in a queued state. Only backups that are actively being processed, successfully completed, or marked as failed are returned.

For detailed guidance on backup and restore functionality, please refer to Backup and Restore Data.

The provided API key must have at least one of the following roles.

  • Organization Owner
  • Project Owner
  • Project Manager

For more information about roles and access, see Organization, Project, and Database Access Overview.

get/v4/organizations/{organizationId}/projects/{projectId}/cloudsnapshotbackups

Query parameters

pageinteger

Sets the page you would like to view.

perPageinteger

Sets the number of results you would like to have on each page.

sortBystring[]

Specifies the sorting criteria for the results, including the key by which the results should be ordered. Valid fields to sort the results include the following. - creationDateTime - createdBy - currentStatus - cloudProvider - region Provide the desired fields in the order of sorting preference.

sortDirection'asc' | 'desc'

The order in which the items will be sorted.

Response

Successful retrieval of the list of backups associated with the clusters within the project.

Example response

{
  "data": [
    {
      "clusterId": "ffffffff-aaaa-1414-eeee-000000000000",
      "clusterName": "example-cluster",
      "creationDateTime": "2024-11-14T14:14:22.122057304Z",
      "createdBy": "user@company.com",
      "currentStatus": "healthy",
      "cloudProvider": "hostedAWS",
      "region": "us-east-1",
      "mostRecentSnapshot": {
        "appService": "3.141.5",
        "cmek": [
          {
            "id": "ffffffff-aaaa-1414-eeee-000000000000",
            "providerId": "arn:aws:kms:us-west-1:123456789012:key/abcd1234-a123-456a-a12b-a123b4cd56ef"
          }
        ],
        "server": {
          "version": "7.1"
        }
      },
      "oldestSnapshot": {
        "appService": "3.141.5",
        "cmek": [
          {
            "id": "ffffffff-aaaa-1414-eeee-000000000000",
            "providerId": "arn:aws:kms:us-west-1:123456789012:key/abcd1234-a123-456a-a12b-a123b4cd56ef"
          }
        ],
        "server": {
          "version": "7.1"
        }
      }
    }
  ],
  "cursor": {
    "pages": {
      "page": 2,
      "next": 3,
      "previous": 1,
      "last": 10,
      "perPage": 10,
      "totalItems": 10
    },
    "hrefs": {
      "first": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "last": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "previous": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "next": "https://cloud.couchbase.com/v4/users?page=1&perPage=10"
    }
  }
}