projects

POST /v1/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations

Changed on Nov 5, 2026

Create a BackupPlanAssociation

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

Query parameters

backupPlanAssociationIdstring

Required. The name of the backup plan association to create. The name must be unique for the specified project and location.

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

Request body

autoProtectionPolicyBindingstring

Output only. The resource name of the AutoProtectionPolicyBinding that manages this association, if any. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{policy}/bindings/{binding}.

backupPlanstring

Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}

backupPlanRevisionIdstring

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

backupPlanRevisionNamestring

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

createTimestring google-datetime

Output only. The time when the instance was created.

dataSourcestring

Output only. Resource name of data source which will be used as storage location for backups taken. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}

namestring

Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}

resourcestring

Required. Immutable. Resource name of workload on which the backup plan is applied. The format can either be the resource name (e.g., "projects/my-project/zones/us-central1-a/instances/my-instance") or the full resource URI (e.g., "https://www.googleapis.com/compute/v1/projects/my-project/zones/us-central1-a/instances/my-instance").

resourceTypestring

Required. Immutable. Resource type of workload on which backupplan is applied

Output only. The BackupPlanAssociation resource state.

updateTimestring google-datetime

Output only. The time when the instance was 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