Google

Backup and DR Service API

Backup and DR Service API endpoints from Google

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Backup and DR Service API endpoints from Google

Endpoints 56

projects.locations.resourceBackupConfigs

  • GETFetches ResourceBackupConfigs./v1/:parent/resourceBackupConfigs:fetch?filter=string&orderBy=string&pageSize=0&pageToken=stringFetches ResourceBackupConfigs.
  • GETLists ResourceBackupConfigs./v1/:parent/resourceBackupConfigs?filter=string&orderBy=string&pageSize=0&pageToken=stringLists ResourceBackupConfigs.

projects.locations.restoreVerificationPlans.associations

  • GETGets details of a single RestoreVerificationPlanAssociation in a given RestoreVerificationPlan./v1/:nameGets details of a single RestoreVerificationPlanAssociation in a given RestoreVerificationPlan.
  • DELETEDeletes a single RestoreVerificationPlanAssociation in a given RestoreVerificationPlan./v1/:name?requestId=stringDeletes a single RestoreVerificationPlanAssociation in a given RestoreVerificationPlan.
  • GETLists RestoreVerificationPlanAssociations in a given RestoreVerificationPlan./v1/:parent/associations?filter=string&orderBy=string&pageSize=0&pageToken=stringLists RestoreVerificationPlanAssociations in a given RestoreVerificationPlan.
  • POSTCreates a new RestoreVerificationPlanAssociation in a given RestoreVerificationPlan./v1/:parent/associations?requestId=string&restoreVerificationPlanAssociationId=stringCreates a new RestoreVerificationPlanAssociation in a given RestoreVerificationPlan.
  • POSTTriggers a new Restore Verification for the association in a given RestoreVerificationPlan./v1/:name:triggerRestoreVerificationTriggers a new Restore Verification for the association in a given RestoreVerificationPlan.

projects.locations.restoreTemplates

  • PATCHUpdates the settings of a RestoreTemplate./v1/:name?requestId=string&updateMask=string&validateOnly=trueUpdates the settings of a RestoreTemplate.
  • GETLists RestoreTemplates in a given project and location./v1/:parent/restoreTemplates?filter=string&orderBy=string&pageSize=0&pageToken=stringLists RestoreTemplates in a given project and location.
  • POSTCreates a new RestoreTemplate in a given project and location./v1/:parent/restoreTemplates?requestId=string&restoreTemplateId=stringCreates a new RestoreTemplate in a given project and location.
  • POSTRuns a RestoreTemplate./v1/:name:runRuns a RestoreTemplate.

projects.locations

  • GETLists information about the supported locations for this service/v1/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service. This method lists locations based on the resource scope provided in the…

projects.locations.appliedAutoProtectionPolicies

  • GETLists AppliedAutoProtectionPolicies in a given project and location./v1/:parent/appliedAutoProtectionPolicies?filter=string&orderBy=string&pageSize=0&pageToken=stringLists AppliedAutoProtectionPolicies in a given project and location.

projects.locations.autoProtectionPolicies

  • GETLists AutoProtectionPolicies for a given project and location./v1/:parent/autoProtectionPolicies?filter=string&orderBy=string&pageSize=0&pageToken=stringLists AutoProtectionPolicies for a given project and location.
  • POSTCreates a new AutoProtectionPolicy in a given project and location./v1/:parent/autoProtectionPolicies?autoProtectionPolicyId=string&requestId=stringCreates a new AutoProtectionPolicy in a given project and location.

projects.locations.autoProtectionPolicies.bindings

  • GETReturns the auto protection policy bindings read from the CCFE tables./v1/:parent/bindings?filter=string&orderBy=string&pageSize=0&pageToken=stringReturns the auto protection policy bindings read from the CCFE tables.
  • POSTCreates a new AutoProtectionPolicyBinding in a given project and location./v1/:parent/bindings?autoProtectionPolicyBindingId=string&requestId=stringCreates a new AutoProtectionPolicyBinding in a given project and location.
  • POSTInitiates delete for AutoProtectionPolicy Binding/v1/:name:initiateDeleteInitiates delete for AutoProtectionPolicy Binding

projects.locations.autoProtectionPolicies.bindings.matchingResources

  • GETLists Binding Matching Resources for a given AutoProtectionPolicyBinding./v1/:parent/matchingResources?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Binding Matching Resources for a given AutoProtectionPolicyBinding.

projects.locations.backupPlanAssociations

  • GETLists BackupPlanAssociations in a given project and location./v1/:parent/backupPlanAssociations?filter=string&pageSize=0&pageToken=stringLists BackupPlanAssociations in a given project and location.
  • POSTCreate a BackupPlanAssociation/v1/:parent/backupPlanAssociations?backupPlanAssociationId=string&requestId=stringCreate a BackupPlanAssociation
  • GETList BackupPlanAssociations for a given resource type./v1/:parent/backupPlanAssociations:fetchForResourceType?filter=string&orderBy=string&pageSize=0&pageToken=string&resourceType=stringList BackupPlanAssociations for a given resource type.
  • POSTTriggers a new Backup./v1/:name:triggerBackupTriggers a new Backup.

projects.locations.backupPlans

  • GETLists BackupPlans in a given project and location./v1/:parent/backupPlans?filter=string&orderBy=string&pageSize=0&pageToken=stringLists BackupPlans in a given project and location.
  • POSTCreate a BackupPlan/v1/:parent/backupPlans?backupPlanId=string&requestId=stringCreate a BackupPlan

projects.locations.backupPlans.revisions

  • GETLists BackupPlanRevisions in a given project and location./v1/:parent/revisions?pageSize=0&pageToken=stringLists BackupPlanRevisions in a given project and location.

projects.locations.backupVaults

  • GETLists BackupVaults in a given project and location./v1/:parent/backupVaults?filter=string&orderBy=string&pageSize=0&pageToken=string&view=BACKUP_VAULT_VIEW_UNSPECIFIEDLists BackupVaults in a given project and location.
  • POSTCreates a new BackupVault in a given project and location./v1/:parent/backupVaults?backupVaultId=string&requestId=string&validateOnly=trueCreates a new BackupVault in a given project and location.
  • GETFetchUsableBackupVaults lists usable BackupVaults in a given project and location/v1/:parent/backupVaults:fetchUsable?filter=string&orderBy=string&pageSize=0&pageToken=stringFetchUsableBackupVaults lists usable BackupVaults in a given project and location. Usable BackupVault are the ones that user has backupdr.backupVaults.get…

projects.locations.managementServers

  • POSTReturns permissions that a caller has on the specified resource/v1/:resource:testIamPermissionsReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND…
  • GETLists ManagementServers in a given project and location./v1/:parent/managementServers?filter=string&orderBy=string&pageSize=0&pageToken=stringLists ManagementServers in a given project and location.
  • POSTCreates a new ManagementServer in a given project and location./v1/:parent/managementServers?managementServerId=string&requestId=stringCreates a new ManagementServer in a given project and location.
  • GETGets the access control policy for a resource/v1/:resource:getIamPolicy?options.requestedPolicyVersion=0Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
  • POSTReturns the Assured Workloads compliance metadata for a given project./v1/:parent:msComplianceMetadataReturns the Assured Workloads compliance metadata for a given project.
  • POSTSets the access control policy on the specified resource/v1/:resource:setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

projects.locations.backupVaults.dataSources

  • POSTInternal only/v1/:dataSource:abandonBackupInternal only. Abandons a backup.
  • POSTInternal only/v1/:name:fetchAccessTokenInternal only. Fetch access token for a given data source.
  • POSTInternal only/v1/:dataSource:finalizeBackupInternal only. Finalize a backup that was started by a call to InitiateBackup.
  • POSTInternal only/v1/:dataSource:initiateBackupInternal only. Initiates a backup.
  • GETLists DataSources in a given project and location./v1/:parent/dataSources?filter=string&orderBy=string&pageSize=0&pageToken=stringLists DataSources in a given project and location.
  • POSTDeletes a DataSource/v1/:name:removeDeletes a DataSource. This is a custom method instead of a standard delete method because external clients will not delete DataSources except for BackupDR…
  • POSTSets the internal status of a DataSource./v1/:dataSource:setInternalStatusSets the internal status of a DataSource.

projects.locations.backupVaults.dataSources.backups

  • GETFetch Backups for a given resource type./v1/:parent/backups:fetchForResourceType?filter=string&orderBy=string&pageSize=0&pageToken=string&resourceType=string&view=BACKUP_VIEW_UNSPECIFIEDFetch Backups for a given resource type.
  • GETLists Backups in a given project and location./v1/:parent/backups?filter=string&orderBy=string&pageSize=0&pageToken=string&view=BACKUP_VIEW_UNSPECIFIEDLists Backups in a given project and location.
  • POSTRestore from a Backup/v1/:name:restoreRestore from a Backup

projects.locations.dataSourceReferences

  • GETFetch DataSourceReferences for a given project, location and resource type./v1/:parent/dataSourceReferences:fetchForResourceType?filter=string&orderBy=string&pageSize=0&pageToken=string&resourceType=stringFetch DataSourceReferences for a given project, location and resource type.
  • GETLists DataSourceReferences for a given project and location./v1/:parent/dataSourceReferences?filter=string&orderBy=string&pageSize=0&pageToken=stringLists DataSourceReferences for a given project and location.

projects.locations.operations

  • POSTStarts asynchronous cancellation on a long-running operation/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the…
  • GETLists operations that match the specified filter in the request/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

projects.locations.restoreTemplates.executions

  • GETLists RestoreTemplateExecutions in a given project, location and restore template./v1/:parent/executions?filter=string&orderBy=string&pageSize=0&pageToken=stringLists RestoreTemplateExecutions in a given project, location and restore template.
  • POSTTriggers cleanup of restored resources created during execution./v1/:name:triggerRestoreCleanupTriggers cleanup of restored resources created during execution.

projects.locations.restoreVerificationPlans

  • GETLists RestoreVerificationPlans in a given project and location./v1/:parent/restoreVerificationPlans?filter=string&orderBy=string&pageSize=0&pageToken=stringLists RestoreVerificationPlans in a given project and location.
  • POSTCreates a new RestoreVerificationPlan in a given project and location./v1/:parent/restoreVerificationPlans?requestId=string&restoreVerificationPlanId=stringCreates a new RestoreVerificationPlan in a given project and location.

projects.locations.serviceConfig

  • POSTInitializes the service related config for a project./v1/:name:initializeInitializes the service related config for a project.

projects.locations.trial

  • POSTEnds the trial for a project/v1/:parent/trial:endEnds the trial for a project
  • POSTSubscribes to a trial for a project/v1/:parent/trial:subscribeSubscribes to a trial for a project

API details

Base URL
https://backupdr.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 2 scopes
An API key in the key query parameter
Operations
56 operations on 45 pathsPOST 28GET 26PATCH 1DELETE 1
Main resources
projects.locations.backupVaults.dataSources 7projects.locations.managementServers 6projects.locations.restoreVerificationPlans.associations 5projects.locations.backupPlanAssociations 4projects.locations.restoreTemplates 4projects.locations.autoProtectionPolicies.bindings 3projects.locations.backupVaults 3projects.locations.backupVaults.dataSources.backups 3projects.locations.autoProtectionPolicies 2projects.locations.backupPlans 2
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Backup and DR Service API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Backup and DR Service API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Fetches ResourceBackupConfigs.” (GET /v1/:parent/resourceBackupConfigs:fetch?filter=string&orderBy=string&pageSize=0&pageToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Backup and DR Service API?

Backup and DR Service API endpoints from Google It is listed under Developer tools and has 56 endpoints.

Who publishes the Backup and DR Service API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Backup and DR Service API?

Requests go to https://backupdr.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Backup and DR Service API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 2 scopes; an API key in the key query parameter.

How many endpoints does the Backup and DR Service API have?

56 operations on 45 paths (28 POST, 26 GET, 1 PATCH, 1 DELETE). The largest groups are projects.locations.backupVaults.dataSources, projects.locations.managementServers, projects.locations.restoreVerificationPlans.associations, projects.locations.backupPlanAssociations.

Is forking the Backup and DR Service API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.