Method: projects.instances.clusters.backups.patch

Updates a pending or completed Cloud Bigtable Backup.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



A globally unique identifier for the backup which cannot be changed. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/ backups/[_a-zA-Z0-9][-_.a-zA-Z0-9]* The final segment of the name must be between 1 and 50 characters in length.

The backup is stored in the cluster identified by the prefix of the backup name of the form projects/{project}/instances/{instance}/clusters/{cluster}.

Query parameters


string (FieldMask format)

Required. A mask specifying which fields (e.g. expireTime) in the Backup resource should be updated. This mask is relative to the Backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Backup.

Response body

If successful, the response body contains an instance of Backup.

Authorization Scopes

Requires one of the following OAuth scopes:


For more information, see the Authentication Overview.