Method: projects.instances.clusters.backups.create

Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. This must be one of the clusters in the instance in which this table is located. The backup will be stored in this cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

Authorization requires one or more of the following IAM permissions on the specified resource parent:

  • bigtable.backups.create
  • bigtable.tables.readRows

Query parameters



Required. The id of the backup to be created. The backupId along with the parent parent are combined as {parent}/backups/{backupId} to create the full backup name, of the form: projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backupId}. This string must be between 1 and 50 characters in length and match the regex [_a-zA-Z0-9][-_.a-zA-Z0-9]*.

Request body

The request body contains an instance of Backup.

Response body

If successful, the response body contains a newly created instance of Operation.

Authorization scopes

Requires one of the following OAuth scopes:


For more information, see the Authentication Overview.