projects

PATCH /v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}

Changed on Nov 5, 2026

Update a BackupPlan.

Request

Base URL
https://backupdr.googleapis.com
Auth
- OAuth 2 and OAuth 2
  Implicit: https://accounts.google.com/o/oauth2/auth
  Scopes: https://www.googleapis.com/auth/cloud-backupdr
  Authorization code: https://accounts.google.com/o/oauth2/auth
  Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-backupdr
- or OAuth 2 and OAuth 2
  Implicit: https://accounts.google.com/o/oauth2/auth
  Scopes: https://www.googleapis.com/auth/cloud-platform
  Authorization code: https://accounts.google.com/o/oauth2/auth
  Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform

Path parameters

projectsIdstring required

locationsIdstring required

backupPlansIdstring required

Query parameters

requestIdstring

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

updateMaskstring google-fieldmask

Required. The list of fields to update. Field mask is used to specify the fields to be overwritten in the BackupPlan resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail. Currently, these fields are supported in update: description, schedules, retention period, adding and removing Backup Rules.

Request body

backupVaultstring

Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}

backupVaultServiceAccountstring

Output only. The Google Cloud service account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account.

createTimestring google-datetime

Output only. When the BackupPlan was created.

descriptionstring

Optional. The description of the BackupPlan resource. The description allows for additional details about BackupPlan and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters.

etagstring

Optional. etag is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources.

labelsobject

Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.

logRetentionDaysstring int64

Optional. Applicable only for Cloud SQL resource_type. Configures how long logs will be stored. It is defined in “days”. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.

maxCustomOnDemandRetentionDaysinteger

Optional. Optional field to configure the maximum number of days for which a backup can be retained. This field is only applicable for on-demand backups taken with custom retention value.

namestring

Output only. Identifier. The resource name of the BackupPlan. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}

resourceTypestring

Required. The resource type to which the BackupPlan will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance", "alloydb.googleapis.com/Cluster", "compute.googleapis.com/Disk".

revisionIdstring

Output only. The user friendly revision ID of the BackupPlanRevision. Example: v0, v1, v2, etc.

revisionNamestring

Output only. The resource id of the BackupPlanRevision. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}

Output only. The State for the BackupPlan.

supportedResourceTypesstring[]

Output only. All resource types to which backupPlan can be applied.

updateTimestring google-datetime

Output only. When the BackupPlan was last updated.

Response

Successful response

doneboolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadataobject

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

namestring

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

responseobject

The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

Changes

Nov 5, 2026da857420b4f6 Revision changes
- info
  the security scope https://www.googleapis.com/auth/cloud-backupdr was added to the endpoint's security scheme Oauth2
- info
  the security scope https://www.googleapis.com/auth/cloud-backupdr was added to the endpoint's security scheme Oauth2c
- info
  the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2
- info
  the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2c
Oct 29, 20263244196e66b0 Revision changes
- info
  the security scope https://www.googleapis.com/auth/cloud-backupdr was added to the endpoint's security scheme Oauth2
- info
  the security scope https://www.googleapis.com/auth/cloud-backupdr was added to the endpoint's security scheme Oauth2c
- info
  the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2
- info
  the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2c

Operation history