Method: projects.locations.backupPlans.patch

Update a BackupPlan.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
backupPlan.name

string

Output only. The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. This is used to specify the fields to be overwritten in the BackupPlan 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 (e.g., description, backupConfig.include_volume_data, etc.) If no updateMask is provided, all fields in backupPlan will be written to the target BackupPlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in backupPlan are ignored and are not used to update the target BackupPlan.

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

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.