In addition to managed backups, you can take manual backups to your own storage bucket with self-managed backups. Refer to the page.
Upgrades and downgrades
If you have upgraded from a Basic cluster to a Standard cluster, the existing backup schedules will still apply, but you can then configure the frequency and retention of future managed backups in the Standard cluster. If you have downgraded from a Standard cluster to a Basic cluster, existing managed backups will be retained for the configured retention duration. The default managed backups in Basic clusters will be taken every 24 hours and have a 30-day retention.Considerations
- Every backup will be stored entirely in a single region, which is chosen at random from the list of cluster regions at the time of cluster creation. This region will be used indefinitely to store backups.
- You can perform a cross-cluster restore across clusters in the same organization. However, the target cluster must also be a Basic cluster and be completely wiped of data.
Required permissions to restore managed backups
To restore a managed backup successfully in CockroachDB Cloud, you must have the appropriate on both the source and destination clusters:- You must have either the or role on the destination cluster, or at the . Without one of these roles, the restore job will fail.
- You must also have either the or role on the source cluster (the cluster from which the backup was taken), or at the . If you do not have the required permissions on the source cluster, the restore will fail.
Organization-level permissions take precedence over cluster-specific permissions. If you have the appropriate role at the organization level, you are authorized to perform restore operations on all clusters within that organization.
Cloud Console
View backups
Click on Backup and Restore in the Data section of the left-side navigation to access the Backup Recovery page. This page displays a list of your cluster backups. Use the calendar drop-down to view all backups taken on a certain date. For each backup, the following details display:- Data From: The date and time the backup was taken.
- Status: The backup’s status,
In ProgressorComplete. - Expires In: The remaining number of days Cockroach Labs will retain the backup.
- Restore: Restore a particular cluster backup, click Restore in the corresponding row.
Restore a cluster
Before a cluster can be restored from a managed backup, the destination cluster must be completely wiped of data. A cluster restore job fails if the destination cluster contains any databases/schemas/tables.
- Find the cluster backup on the Backup Recovery page.
- Click Restore for the cluster you want to restore. The Restore cluster module displays with backup details.
- You can restore a backup to the same cluster or a different Basic cluster. The target cluster must already be created. Select the desired target cluster under Restore to cluster and click Continue
- Review the restore details then click Restore.
Cloud API
You can use the to view managed backups or restore clusters from a managed backup.The associated with the secret key must have the role.
View managed backups
To view a list of managed backups on a cluster with timestamps and their respective IDs, send aGET request to the /v1/clusters/{cluster_id}/backups endpoint:
Restore from a managed backup
You can use the/v1/clusters/{destination_cluster_id}/restores endpoint to restore the contents of a managed backup to a specified destination cluster.
On Standard and Basic clusters, managed backups can only be restored at the cluster level into the same cluster or a different cluster of the same plan type in the same organization.
Restore a cluster
Before a cluster can be restored from a managed backup, the destination cluster must be completely wiped of data. A cluster restore operation fails if the destination cluster contains any databases/schemas/tables. To restore a cluster to a recent managed backup, send aPOST request to the /v1/clusters/{cluster_id}/restores endpoint of "type": "CLUSTER":
source_cluster_id. To restore a specific backup, include the backup_id field and specify a backup ID from the managed backups list:
source_cluster_id.
restore_opts object. For more information, see the API endpoint documentation.
If the request is successful, the client recieves a JSON response that describes the request operation:
Get status of a restore job
To view the status of a restore job using the cloud API, send aGET request to the /v1/clusters/{cluster_id}/restores/{restore_id} endpoint where restore_id is the id from the JSON response:

