--- title: "List Cloud Snapshot Backups at the Project Level" method: GET path: "/v4/organizations/{organizationId}/projects/{projectId}/cloudsnapshotbackups" tags: ["Cloud Snapshot Backups & Restore"] --- # List Cloud Snapshot Backups at the Project Level `GET /v4/organizations/{organizationId}/projects/{projectId}/cloudsnapshotbackups` ## Request - Base URL: `https://cloudapi.cloud.couchbase.com` - URL: `https://cloudapi.cloud.couchbase.com/v4/organizations/{organizationId}/projects/{projectId}/cloudsnapshotbackups` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) 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](https://docs.couchbase.com/cloud/clusters/cloud-snapshots.html). 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](https://docs.couchbase.com/cloud/organizations/organization-projects-overview.html). ## Query parameters - `page` integer - `perPage` integer - `sortBy` string[] - `sortDirection` 'asc' | 'desc' ## Response `200` Successful retrieval of the list of backups associated with the clusters within the project. - ListProjectLevelCloudSnapshotResponse - `data` GetProjectLevelCloudSnapshotBackupResponse[], required - `clusterId` string: The unique identifier of the cluster. - `clusterName` string: The name assigned to the cluster. - `creationDateTime` string, date-time: The date and time when the cluster was created, in ISO 8601 format. - `createdBy` string: The identifier or name of the user who created the cluster. - `currentStatus` string: The current operational status of the cluster (e.g., healthy, destroyed, scaling). - `cloudProvider` string: The cloud service provider hosting the cluster (e.g., AWS, Azure, GCP). - `region` string: The geographical region where the cluster is deployed. - `mostRecentSnapshot` GetCloudSnapshotBackupResponse - `clusterId` string - `createdAt` string, date-time - `expiration` string, date-time - `id` string - `progress` CloudSnapshotBackupProgress - `status` string - `time` string, date-time - `projectId` string - `appService` string: The version of any App Services which are associated with the cluster. - `cmek` ClusterCMEKConfig[] - `id` string, uuid, required: UUID of the customer managed encryption key. - `providerId` string: ProviderId is the ID of the customer managed encryption key as stored by the cloud provider. - `crossRegionCopies` CloudSnapshotBackupCrossRegionCopies[] - `regionCode` string - `status` string - `time` string, date-time - `retention` integer - `server` CouchbaseServer - `version` string: Version of the Couchbase Server to be installed in the cluster. Refer to documentation [here](https://docs.couchbase.com/cloud/clusters/upgrade-database.html#server-version-maintenance-support) for list of supported versions. The latest Couchbase Server version will be deployed by default. - `databaseSize` integer - `tenantId` string - `type` string - `oldestSnapshot` GetCloudSnapshotBackupResponse - `clusterId` string - `createdAt` string, date-time - `expiration` string, date-time - `id` string - `progress` CloudSnapshotBackupProgress - `status` string - `time` string, date-time - `projectId` string - `appService` string: The version of any App Services which are associated with the cluster. - `cmek` ClusterCMEKConfig[] - `id` string, uuid, required: UUID of the customer managed encryption key. - `providerId` string: ProviderId is the ID of the customer managed encryption key as stored by the cloud provider. - `crossRegionCopies` CloudSnapshotBackupCrossRegionCopies[] - `regionCode` string - `status` string - `time` string, date-time - `retention` integer - `server` CouchbaseServer - `version` string: Version of the Couchbase Server to be installed in the cluster. Refer to documentation [here](https://docs.couchbase.com/cloud/clusters/upgrade-database.html#server-version-maintenance-support) for list of supported versions. The latest Couchbase Server version will be deployed by default. - `databaseSize` integer - `tenantId` string - `type` string - `cursor` Cursor, required - `pages` Pages, required - `page` integer, required: Current page of results, starting from page 1. - `next` integer: Number of the next page of results. Not set on the last page. - `previous` integer: Number of the previous page of results. Not set on the first page. - `last` integer, required: Number of the last page of results. - `perPage` integer, required: Number of items displayed in each page. - `totalItems` integer, required: Total items found by the given query. - `hrefs` Hrefs, required - `first` string, uri, required: The base URL, endpoint, and path parameters required to fetch the first page of results. - `last` string, uri, required: The base URL, endpoint, and path parameters required to fetch the last page of results. - `previous` string, uri, required: The base URL, endpoint, and path parameters required to fetch the previous page of results. Empty if there is no previous page. - `next` string, uri, required: The base URL, endpoint, and path parameters required to fetch the next page of results. Empty if there is no next page. ## Other responses - `403`: The client does not have the necessary permissions to access this resource. - `404`: The requested resource was not found. - `429`: Returned when the client exceeds the rate limit for the given APIKey. - `500`: An unexpected error occurred in the server while processing this request. --- [API](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api.md) - [All operations](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/revisions/a5e88bcf71cb?raw)