Backup and DR Service API (backupdr:v1)

2026-10-21

12 new methods | 1 updated method

Additions

    Methods
  • ▼ ▲ backupdr.projects.locations.autoProtectionPolicies.bindings.initiateDelete

      Path : v1/{+name}:initiateDelete

      Parameter Order : name

      Description : Initiates delete for AutoProtectionPolicy Binding

      HTTP Method : POST

      Parameters :

        name

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+/bindings/[^/]+$

          Location : path

          Description : Required. The name of the binding to delete. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}

          Type : string

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}/bindings/{bindingsId}:initiateDelete

      Scopes :

    • https://www.googleapis.com/auth/cloud-backupdr
    • https://www.googleapis.com/auth/cloud-platform
  • ▼ ▲ backupdr.projects.locations.autoProtectionPolicies.bindings.get

      Parameter Order : name

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}/bindings/{bindingsId}

      Parameters :

        name

          Pattern : ^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+/bindings/[^/]+$

          Required : Yes

          Description : Required. The name of the binding to retrieve. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}

          Location : path

          Type : string

      Scopes :

    • https://www.googleapis.com/auth/cloud-backupdr
    • https://www.googleapis.com/auth/cloud-platform
    • HTTP Method : GET

      Description : Returns the auto protection policy binding read from the CCFE tables.

  • ▼ ▲ backupdr.projects.locations.autoProtectionPolicies.bindings.list

      Parameter Order : parent

      Scopes :

    • https://www.googleapis.com/auth/cloud-backupdr
    • https://www.googleapis.com/auth/cloud-platform
    • Flat Path : v1/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}/bindings

      Path : v1/{+parent}/bindings

      Description : Returns the auto protection policy bindings read from the CCFE tables.

      HTTP Method : GET

      Parameters :

        parent

          Pattern : ^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+$

          Location : path

          Description : Required. The project and location for which to retrieve the list of policies. Format: projects/{project}/locations/{location}

          Type : string

          Required : Yes

        pageSize

          Type : integer

          Format : int32

          Description : Optional. The maximum number of policies to return in a single page is 500. If unspecified, a server-default value will be used.

          Location : query

        orderBy

          Type : string

          Description : Optional. An expression that sorts the results in the response. The following fields are sortable:

          Location : query

        pageToken

          Type : string

          Location : query

          Description : Optional. A page token, received from a previous `ListAutoProtectionPolicies` call. Provide this to retrieve the subsequent page.

        filter

          Location : query

          Type : string

          Description : Optional. A filter expression that filters resources listed in the response. The following fields are filterable:

  • ▼ ▲ backupdr.projects.locations.autoProtectionPolicies.bindings.create

      HTTP Method : POST

      Parameters :

        parent

          Pattern : ^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+$

          Description : Required. The parent resource where this binding will be created. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}

          Location : path

          Type : string

          Required : Yes

        autoProtectionPolicyBindingId

          Description : Required. The ID to use for the binding. This will become the final component of the binding's resource name.

          Type : string

          Location : query

      Parameter Order : parent

      Scopes :

    • https://www.googleapis.com/auth/cloud-backupdr
    • https://www.googleapis.com/auth/cloud-platform
    • Description : Creates a new AutoProtectionPolicyBinding in a given project and location.

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}/bindings

      Path : v1/{+parent}/bindings

  • ▼ ▲ backupdr.projects.locations.autoProtectionPolicies.bindings.matchingResources.get

      Description : Gets details of a single Binding Matching Resource.

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}/bindings/{bindingsId}/matchingResources/{matchingResourcesId}

      Parameters :

        name

          Pattern : ^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+/bindings/[^/]+/matchingResources/[^/]+$

          Required : Yes

          Type : string

          Description : Required. The name of the matching resource to retrieve. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}/matchingResources/{matching_resource}

          Location : path

      Scopes :

    • https://www.googleapis.com/auth/cloud-backupdr
    • https://www.googleapis.com/auth/cloud-platform
    • HTTP Method : GET

      Parameter Order : name

  • ▼ ▲ backupdr.projects.locations.autoProtectionPolicies.bindings.matchingResources.list

      Scopes :

    • https://www.googleapis.com/auth/cloud-backupdr
    • https://www.googleapis.com/auth/cloud-platform
    • HTTP Method : GET

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}/bindings/{bindingsId}/matchingResources

      Description : Lists Binding Matching Resources for a given AutoProtectionPolicyBinding.

      Parameter Order : parent

      Parameters :

        parent

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+/bindings/[^/]+$

          Required : Yes

          Description : Required. The project, location, auto protection policy and binding for which to retrieve `BindingMatchingResources` information. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}`. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**.

          Type : string

        pageSize

          Description : Optional. The maximum number of `BindingMatchingResources` to return in a single response. The default page size is 100 and maximum page size is 200. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.

          Location : query

          Type : integer

          Format : int32

        filter

          Location : query

          Description : Optional. Field match expression used to filter the results.

          Type : string

        orderBy

          Type : string

          Description : Optional. Field by which to sort the results.

          Location : query

        pageToken

          Location : query

          Type : string

          Description : Optional. The value of next_page_token received from a previous `ListBindingMatchingResources` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBindingMatchingResources` must match the call that provided the page token.

      Path : v1/{+parent}/matchingResources

  • ▼ ▲ backupdr.projects.locations.autoProtectionPolicies.patch

      Path : v1/{+name}

      Description : Updates the parameters of a single AutoProtectionPolicy.

      Scopes :

    • https://www.googleapis.com/auth/cloud-backupdr
    • https://www.googleapis.com/auth/cloud-platform
    • Flat Path : v1/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}

      HTTP Method : PATCH

      Parameter Order : name

      Parameters :

        updateMask

          Format : google-fieldmask

          Description : Optional. Field mask is used to specify the fields to be overwritten in the AutoProtectionPolicy 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 all fields will be overwritten.

          Location : query

          Type : string

        name

          Description : Identifier. The resource name of the AutoProtectionPolicy. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}`

          Pattern : ^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+$

          Location : path

          Required : Yes

          Type : string

  • ▼ ▲ backupdr.projects.locations.autoProtectionPolicies.delete

      Scopes :

    • https://www.googleapis.com/auth/cloud-backupdr
    • https://www.googleapis.com/auth/cloud-platform
    • Description : Deletes a single AutoProtectionPolicy.

      Parameter Order : name

      Parameters :

        name

          Location : path

          Type : string

          Description : Required. The name of the policy to delete. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+$

        etag

          Location : query

          Description : The current etag of the autoprotectionpolicy. If an etag is provided and does not match the current etag of the connection, deletion will be blocked.

          Type : string

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}

      HTTP Method : DELETE

      Path : v1/{+name}

  • ▼ ▲ backupdr.projects.locations.autoProtectionPolicies.create

      HTTP Method : POST

      Parameter Order : parent

      Path : v1/{+parent}/autoProtectionPolicies

      Description : Creates a new AutoProtectionPolicy in a given project and location.

      Parameters :

        parent

          Location : path

          Description : Required. The parent resource where this policy will be created. Format: projects/{project}/locations/{location}

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Type : string

          Required : Yes

        autoProtectionPolicyId

          Location : query

          Description : Required. The ID to use for the policy. This will become the final component of the policy's resource name.

          Type : string

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies

      Scopes :

    • https://www.googleapis.com/auth/cloud-backupdr
    • https://www.googleapis.com/auth/cloud-platform
  • ▼ ▲ backupdr.projects.locations.autoProtectionPolicies.get

      Scopes :

    • https://www.googleapis.com/auth/cloud-backupdr
    • https://www.googleapis.com/auth/cloud-platform
    • Flat Path : v1/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}

      Description : Gets details of a single AutoProtectionPolicy.

      HTTP Method : GET

      Path : v1/{+name}

      Parameter Order : name

      Parameters :

        name

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+$

          Description : Required. The name of the policy to retrieve. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}

          Type : string

          Location : path

  • ▼ ▲ backupdr.projects.locations.autoProtectionPolicies.list

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies

      Description : Lists AutoProtectionPolicies for a given project and location.

      Scopes :

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

        filter

          Location : query

          Description : Optional. A filter expression that filters resources listed in the response. The following fields are filterable:

          Type : string

        pageSize

          Format : int32

          Location : query

          Description : Optional. The maximum number of policies to return in a single page. If unspecified, a server-default value will be used.

          Type : integer

        pageToken

          Description : Optional. A page token, received from a previous `ListAutoProtectionPolicies` call. Provide this to retrieve the subsequent page.

          Type : string

          Location : query

        parent

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Location : path

          Type : string

          Description : Required. The project and location for which to retrieve the list of policies. Format: projects/{project}/locations/{location}

        orderBy

          Location : query

          Type : string

          Description : Optional. An expression that sorts the results in the response. The following fields are sortable:

      Path : v1/{+parent}/autoProtectionPolicies

      Parameter Order : parent

      HTTP Method : GET

  • ▼ ▲ backupdr.projects.locations.appliedAutoProtectionPolicies.list

      HTTP Method : GET

      Parameter Order : parent

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/appliedAutoProtectionPolicies

      Description : Lists AppliedAutoProtectionPolicies in a given project and location.

      Parameters :

        pageSize

          Type : integer

          Description : Optional. The maximum number of applied policies to return in a single page. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified or set to 0, a default page size of 500 will be used.

          Format : int32

          Location : query

        filter

          Description : Optional. A filter expression that filters resources listed in the response.

          Location : query

          Type : string

        pageToken

          Type : string

          Location : query

          Description : Optional. A page token, received from a previous `ListAppliedAutoProtectionPolicies` call.

        orderBy

          Description : Optional. An expression that sorts the results in the response.

          Location : query

          Type : string

        parent

          Type : string

          Required : Yes

          Description : Required. The project and location for which to retrieve the list of applied policies. Format: projects/{project}/locations/{location}

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+$

      Scopes :

    • https://www.googleapis.com/auth/cloud-backupdr
    • https://www.googleapis.com/auth/cloud-platform
    • Path : v1/{+parent}/appliedAutoProtectionPolicies

Updates

    Methods
  • ▼ ▲ backupdr.projects.locations.backupPlanAssociations.delete

      Parameters :

        autoProtectionPolicyBinding

          Location : query

          Type : string

          Description : Optional. This field is exclusively used by Backup and DR's auto-protection feature. The resource name of the `AutoProtectionPolicyBinding` that triggered the deletion of this association. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{policy}/bindings/{binding}`.