Method: projects.locations.backupPlans.backups.patch

Update a Backup.

HTTP request

PATCH https://gkebackup.googleapis.com/v1/{backup.name=projects/*/locations/*/backupPlans/*/backups/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
backup.name

string

Output only. The fully qualified name of the Backup. projects/*/locations/*/backupPlans/*/backups/*

Query parameters

Parameters
updateMask

string (FieldMask format)

This is used to specify the fields to be overwritten in the Backup targeted for update. The values for each of these updated fields will be taken from the backupPlan provided with this request. Field names are relative to the root of the resource. If no updateMask is provided, all fields in backup will be written to the target Backup resource. Note that OUTPUT_ONLY and IMMUTABLE fields in backup are ignored and are not used to update the target Backup.

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 Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.