Microsoft Azure

Azure Dataprotection

Open API 2.0 Specs for Azure Data Protection service

Data & analytics#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

Open API 2.0 Specs for Azure Data Protection service

Endpoints 75

Operations

  • GETDataProtectionOperations_List/providers/Microsoft.DataProtection/operationsList the operations for the provider

BackupInstances

  • GETBackupInstances_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupInstancesGets a backup instances belonging to a backup vault
  • GETBackupInstances_GetBackupInstanceOperationResult/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupInstances/:backupInstanceName/operationResults/:operationIdGet result of backup instance creation operation

BackupVaultResources

  • GETBackupVaults_GetInSubscription/subscriptions/:subscriptionId/providers/Microsoft.DataProtection/backupVaultsReturns resource collection belonging to a subscription.
  • GETBackupVaults_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultNameReturns a resource belonging to a resource group.
  • PUTBackupVaults_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultNameCreates or updates a BackupVault resource belonging to a resource group.
  • DELETEBackupVaults_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultNameDeletes a BackupVault resource from the resource group.
  • PATCHBackupVaults_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultNameUpdates a BackupVault resource belonging to a resource group. For example, updating tags for a resource.
  • GETExportJobsOperationResult_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupJobs/operations/:operationIdGets the operation result of operation triggered by Export Jobs API. If the operation is successful, then it also contains URL of a Blob and a SAS key to…
  • POSTExportJobs_Trigger/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/exportBackupJobsTriggers export of jobs and returns an OperationID to track.
  • GETOperationStatusBackupVaultContext_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/operationStatus/:operationIdGets the operation status for an operation over a BackupVault's context.
  • POSTBackupInstances_ValidateForBackup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/validateForBackupValidate whether adhoc backup will be successful or not

BackupVaultOperationResults

  • GETBackupVaults_GetInResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaultsReturns resource collection belonging to a resource group.
  • GETBackupVaultOperationResults_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/operationResults/:operationIdGet a BackupVaultResource

DeletedBackupVaults

  • GETDeletedBackupVaults_ListByLocation/subscriptions/:subscriptionId/providers/Microsoft.DataProtection/locations/:location/deletedVaultsLists deleted backup vaults by location
  • GETDeletedBackupVaults_Get/subscriptions/:subscriptionId/providers/Microsoft.DataProtection/locations/:location/deletedVaults/:deletedVaultNameGets a deleted backup vault

BaseBackupPolicyResources

  • GETBackupPolicies_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupPoliciesReturns list of backup policies belonging to a backup vault
  • GETBackupPolicies_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupPolicies/:backupPolicyNameGets a backup policy belonging to a backup vault
  • PUTBackupPolicies_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupPolicies/:backupPolicyNameCreates or Updates a backup policy belonging to a backup vault
  • DELETEBackupPolicies_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupPolicies/:backupPolicyNameDeletes a backup policy belonging to a backup vault

BackupInstanceResources

  • GETBackupInstances_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupInstances/:backupInstanceNameGets a backup instance with name in a backup vault
  • PUTBackupInstances_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupInstances/:backupInstanceNameCreate or update a backup instance in a backup vault
  • DELETEBackupInstances_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupInstances/:backupInstanceNameDelete a backup instance in a backup vault
  • POSTBackupInstances_AdhocBackup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupInstances/:backupInstanceName/backupTrigger adhoc backup
  • POSTRestorableTimeRanges_Find/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupInstances/:backupInstanceName/findRestorableTimeRanges
  • POSTBackupInstances_TriggerRehydrate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupInstances/:backupInstanceName/rehydraterehydrate recovery point for restore for a BackupInstance
  • POSTBackupInstances_TriggerRestore/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupInstances/:backupInstanceName/restoreTriggers restore for a BackupInstance
  • POSTBackupInstances_ResumeBackups/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupInstances/:backupInstanceName/resumeBackupsThis operation will resume backups for backup instance
  • POSTBackupInstances_ResumeProtection/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupInstances/:backupInstanceName/resumeProtectionThis operation will resume protection for a stopped backup instance
  • POSTBackupInstances_StopProtection/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupInstances/:backupInstanceName/stopProtectionThis operation will stop protection of a backup instance and data will be held forever
  • POSTBackupInstances_SuspendBackups/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupInstances/:backupInstanceName/suspendBackupsThis operation will stop backup for a backup instance and retains the backup data as per the policy (except latest Recovery point, which will be retained…
  • POSTBackupInstances_SyncBackupInstance/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupInstances/:backupInstanceName/syncSync backup instance again in case of failure This action will retry last failed operation and will bring backup instance to valid state
  • POSTBackupInstances_ValidateForModifyBackup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupInstances/:backupInstanceName/validateForModifyBackupValidate whether update for backup instance will be successful or not
  • POSTBackupInstances_ValidateForRestore/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupInstances/:backupInstanceName/validateRestoreValidates if Restore can be triggered for a DataSource

AzureBackupRecoveryPointResources

  • GETRecoveryPoints_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupInstances/:backupInstanceName/recoveryPoints?$filter=string&$skipToken=stringReturns a list of Recovery Points for a DataSource in a vault.
  • GETRecoveryPoints_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupInstances/:backupInstanceName/recoveryPoints/:recoveryPointIdGets a Recovery Point using recoveryPointId for a Datasource.

AzureBackupJobResources

  • GETJobs_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupJobsReturns list of jobs belonging to a backup vault
  • GETJobs_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupJobs/:jobIdGets a job with id in a backup vault

DeletedBackupInstanceResources

  • GETDeletedBackupInstances_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/deletedBackupInstancesGets deleted backup instances belonging to a backup vault
  • GETDeletedBackupInstances_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/deletedBackupInstances/:backupInstanceNameGets a deleted backup instance with name in a backup vault
  • POSTDeletedBackupInstances_Undelete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/deletedBackupInstances/:backupInstanceName/undeleteA long-running resource action.

ResourceGuards

  • GETResourceGuards_GetDeleteResourceGuardProxyRequestsObjects/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/resourceGuards/:resourceGuardsName/deleteResourceGuardProxyRequestsReturns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
  • GETResourceGuards_GetDefaultDeleteResourceGuardProxyRequestsObject/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/resourceGuards/:resourceGuardsName/deleteResourceGuardProxyRequests/:requestNameReturns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.

ResourceGuardResources

  • GETResourceGuards_GetResourcesInSubscription/subscriptions/:subscriptionId/providers/Microsoft.DataProtection/resourceGuardsReturns ResourceGuards collection belonging to a subscription.
  • GETResourceGuards_GetResourcesInResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/resourceGuardsReturns ResourceGuards collection belonging to a ResourceGroup.
  • GETResourceGuards_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/resourceGuards/:resourceGuardsNameReturns a ResourceGuard belonging to a resource group.
  • PUTResourceGuards_Put/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/resourceGuards/:resourceGuardsNameCreates or updates a ResourceGuard resource belonging to a resource group.
  • DELETEResourceGuards_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/resourceGuards/:resourceGuardsNameDeletes a ResourceGuard resource from the resource group.
  • PATCHResourceGuards_Patch/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/resourceGuards/:resourceGuardsNameUpdates a ResourceGuard resource belonging to a resource group. For example, updating tags for a resource.

DppBaseResourceOperationGroup

  • GETResourceGuards_GetDeleteProtectedItemRequestsObjects/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/resourceGuards/:resourceGuardsName/deleteProtectedItemRequestsReturns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
  • GETResourceGuards_GetDefaultDeleteProtectedItemRequestsObject/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/resourceGuards/:resourceGuardsName/deleteProtectedItemRequests/:requestNameReturns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
  • GETResourceGuards_GetDisableSoftDeleteRequestsObjects/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/resourceGuards/:resourceGuardsName/disableSoftDeleteRequestsReturns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
  • GETResourceGuards_GetDefaultDisableSoftDeleteRequestsObject/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/resourceGuards/:resourceGuardsName/disableSoftDeleteRequests/:requestNameReturns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
  • GETResourceGuards_GetBackupSecurityPINRequestsObjects/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/resourceGuards/:resourceGuardsName/getBackupSecurityPINRequestsReturns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
  • GETResourceGuards_GetDefaultBackupSecurityPINRequestsObject/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/resourceGuards/:resourceGuardsName/getBackupSecurityPINRequests/:requestNameReturns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
  • GETResourceGuards_GetUpdateProtectedItemRequestsObjects/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/resourceGuards/:resourceGuardsName/updateProtectedItemRequestsReturns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
  • GETResourceGuards_GetDefaultUpdateProtectedItemRequestsObject/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/resourceGuards/:resourceGuardsName/updateProtectedItemRequests/:requestNameReturns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
  • GETResourceGuards_GetUpdateProtectionPolicyRequestsObjects/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/resourceGuards/:resourceGuardsName/updateProtectionPolicyRequestsReturns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.
  • GETResourceGuards_GetDefaultUpdateProtectionPolicyRequestsObject/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/resourceGuards/:resourceGuardsName/updateProtectionPolicyRequests/:requestNameReturns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.

ResourceGuardProxyBaseResources

  • GETDppResourceGuardProxy_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupResourceGuardProxiesReturns the list of ResourceGuardProxies associated with the vault
  • GETDppResourceGuardProxy_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupResourceGuardProxies/:resourceGuardProxyNameReturns the ResourceGuardProxy object associated with the vault, and that matches the name in the request
  • PUTDppResourceGuardProxy_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupResourceGuardProxies/:resourceGuardProxyNameCreates or Updates a ResourceGuardProxy
  • DELETEDppResourceGuardProxy_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupResourceGuardProxies/:resourceGuardProxyNameDeletes the ResourceGuardProxy
  • POSTDppResourceGuardProxy_UnlockDelete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/backupVaults/:vaultName/backupResourceGuardProxies/:resourceGuardProxyName/unlockDeleteUnlockDelete call for ResourceGuardProxy, executed before one can delete it
  • GETBackupInstancesExtensionRouting_List/:resourceId/providers/Microsoft.DataProtection/backupInstancesGets a list of backup instances associated with a tracked resource
  • POSTValidates if a feature is supported/subscriptions/:subscriptionId/providers/Microsoft.DataProtection/locations/:location/checkFeatureSupportValidates if a feature is supported
  • GETGets the operation status for a resource./subscriptions/:subscriptionId/providers/Microsoft.DataProtection/locations/:location/operationResults/:operationIdGets the operation result for a resource
  • GETGets the operation status for a resource./subscriptions/:subscriptionId/providers/Microsoft.DataProtection/locations/:location/operationStatus/:operationIdGets the operation status for a resource.
  • POSTAPI to check for resource name availability/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/locations/:location/checkNameAvailabilityAPI to check for resource name availability
  • POSTBackupInstances_TriggerCrossRegionRestore/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/locations/:location/crossRegionRestoreTriggers Cross Region Restore for BackupInstance.
  • POSTFetchCrossRegionRestoreJob_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/locations/:location/fetchCrossRegionRestoreJobFetches the Cross Region Restore Job
  • POSTFetchCrossRegionRestoreJobs_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/locations/:location/fetchCrossRegionRestoreJobs?$filter=stringFetches list of Cross Region Restore job belonging to the vault
  • POSTFetchSecondaryRecoveryPoints_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/locations/:location/fetchSecondaryRecoveryPoints?$filter=string&$skipToken=stringReturns a list of Secondary Recovery Points for a DataSource in a vault, that can be used for Cross Region Restore.
  • POSTBackupInstances_ValidateCrossRegionRestore/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/locations/:location/validateCrossRegionRestoreValidates whether Cross Region Restore can be triggered for DataSource.
  • GETGets the operation status for an operation over a ResourceGroup's context./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataProtection/operationStatus/:operationIdGets the operation status for an operation over a ResourceGroup's context.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
75 operations on 63 pathsGET 41POST 22PUT 5DELETE 5PATCH 2
Main resources
BackupInstanceResources 14DppBaseResourceOperationGroup 10BackupVaultResources 9ResourceGuardResources 6ResourceGuardProxyBaseResources 5BaseBackupPolicyResources 4DeletedBackupInstanceResources 3AzureBackupJobResources 2AzureBackupRecoveryPointResources 2BackupInstances 2
Response formats
application/json
Description format
Swagger 2.0, API version 2026-07-01

How to test the Azure Dataprotection 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 Azure Dataprotection collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “DataProtectionOperations_List” (GET /providers/Microsoft.DataProtection/operations), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Dataprotection?

Open API 2.0 Specs for Azure Data Protection service It is listed under Data & analytics and has 75 endpoints.

Who publishes the Azure Dataprotection?

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

What is the base URL of the Azure Dataprotection?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Dataprotection?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Dataprotection have?

75 operations on 63 paths (41 GET, 22 POST, 5 PUT, 5 DELETE, 2 PATCH). The largest groups are BackupInstanceResources, DppBaseResourceOperationGroup, BackupVaultResources, ResourceGuardResources.

Is forking the Azure Dataprotection 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.