Microsoft Azure

RecoveryServicesBackupClient: Recoveryservicesbackup

RecoveryServicesBackupClient endpoints from Microsoft Azure

Developer tools#openapi#cloud

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

RecoveryServicesBackupClient endpoints from Microsoft Azure

Endpoints 33

BackupEngines

  • GETBackupEngines_Get/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupEngines?api-version=string&$filter=string&$skipToken=stringThe backup management servers registered to a Recovery Services vault. This returns a pageable list of servers.

ProtectionContainerRefreshOperationResults

  • GETProtectionContainerRefreshOperationResults_Get/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupFabrics/:fabricName/operationResults/:operationId?api-version=stringProvides the result of the refresh operation triggered by the BeginRefresh operation.

ProtectionContainers

  • GETProtectionContainers_Get/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupFabrics/:fabricName/protectionContainers/:containerName?api-version=stringGets details of the specific container registered to your Recovery Services vault.
  • POSTProtectionContainers_Refresh/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupFabrics/:fabricName/refreshContainers?api-version=stringDiscovers the containers in the subscription that can be protected in a Recovery Services vault. This is an asynchronous operation. To learn the status of the…
  • GETProtectionContainers_List/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupProtectionContainers?api-version=string&$filter=stringLists the containers registered to the Recovery Services vault.

ProtectionContainerOperationResults

  • GETProtectionContainerOperationResults_Get/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupFabrics/:fabricName/protectionContainers/:containerName/operationResults/:operationId?api-version=stringGets the result of any operation on the container.

ProtectedItems

  • GETProtectedItems_Get/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupFabrics/:fabricName/protectionContainers/:containerName/protectedItems/:protectedItemName?api-version=string&$filter=stringProvides the details of the backup item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.
  • PUTProtectedItems_CreateOrUpdate/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupFabrics/:fabricName/protectionContainers/:containerName/protectedItems/:protectedItemName?api-version=stringThis operation enables an item to be backed up, or modifies the existing backup policy information for an item that has been backed up. This is an…
  • DELETEProtectedItems_Delete/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupFabrics/:fabricName/protectionContainers/:containerName/protectedItems/:protectedItemName?api-version=stringUsed to disable the backup job for an item within a container. This is an asynchronous operation. To learn the status of the request, call the…
  • GETProtectedItems_List/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupProtectedItems?api-version=string&$filter=string&$skipToken=stringProvides a pageable list of all items in a subscription, that can be protected.

Backups

  • POSTBackups_Trigger/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupFabrics/:fabricName/protectionContainers/:containerName/protectedItems/:protectedItemName/backup?api-version=stringTriggers the backup job for the specified backup item. This is an asynchronous operation. To know the status of the operation, call…

ProtectedItemOperationResults

  • GETProtectedItemOperationResults_Get/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupFabrics/:fabricName/protectionContainers/:containerName/protectedItems/:protectedItemName/operationResults/:operationId?api-version=stringGets the result of any operation on the backup item.

ProtectedItemOperationStatuses

  • GETProtectedItemOperationStatuses_Get/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupFabrics/:fabricName/protectionContainers/:containerName/protectedItems/:protectedItemName/operationsStatus/:operationId?api-version=stringGets the status of an operation such as triggering a backup or restore. The status can be: In progress, Completed, or Failed. You can refer to the…

RecoveryPoints

  • GETRecoveryPoints_List/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupFabrics/:fabricName/protectionContainers/:containerName/protectedItems/:protectedItemName/recoveryPoints?api-version=string&$filter=stringLists the recovery points, or backup copies, for the specified backup item.
  • GETRecoveryPoints_Get/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupFabrics/:fabricName/protectionContainers/:containerName/protectedItems/:protectedItemName/recoveryPoints/:recoveryPointId?api-version=stringProvides the backup data for the RecoveryPointID. This is an asynchronous operation. To learn the status of the operation, call the…

ItemLevelRecoveryConnections

  • POSTItemLevelRecoveryConnections_Provision/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupFabrics/:fabricName/protectionContainers/:containerName/protectedItems/:protectedItemName/recoveryPoints/:recoveryPointId/provisionInstantItemRecovery?api-version=stringProvisions a script which invokes an iSCSI connection to the backup data. Executing this script opens File Explorer which displays the recoverable files and…
  • POSTItemLevelRecoveryConnections_Revoke/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupFabrics/:fabricName/protectionContainers/:containerName/protectedItems/:protectedItemName/recoveryPoints/:recoveryPointId/revokeInstantItemRecovery?api-version=stringRevokes an iSCSI connection which can be used to download a script. Executing this script opens a file explorer displaying all recoverable files and folders.…

Restores

  • POSTRestores_Trigger/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupFabrics/:fabricName/protectionContainers/:containerName/protectedItems/:protectedItemName/recoveryPoints/:recoveryPointId/restore?api-version=stringRestores the specified backup data. This is an asynchronous operation. To know the status of this API call, use GetProtectedItemOperationResult API.

Jobs

  • GETJobs_List/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupJobs?api-version=string&$filter=string&$skipToken=stringProvides a pageable list of jobs.
  • POSTJobs_Export/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupJobsExport?api-version=string&$filter=stringExports all jobs for a given Shared Access Signatures (SAS) URL. The SAS URL expires within 15 minutes of its creation.

ExportJobsOperationResults

  • GETExportJobsOperationResults_Get/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupJobs/operationResults/:operationId?api-version=stringGets the result of the operation triggered by the ExportJob API.

JobDetails

  • GETJobDetails_Get/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupJobs/:jobName?api-version=stringGets extended information associated with the job.

JobCancellations

  • POSTJobCancellations_Trigger/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupJobs/:jobName/cancel?api-version=stringCancels the job. This is an asynchronous operation. To know the status of the cancellation, call the GetCancelOperationResult API.

JobOperationResults

  • GETJobOperationResults_Get/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupJobs/:jobName/operationResults/:operationId?api-version=stringGets the result of the operation.

BackupOperationResults

  • GETBackupOperationResults_Get/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupOperationResults/:operationId?api-version=stringProvides the status of the delete operations, for example, deleting a backup item. Once the operation starts, the response status code is Accepted. The…

BackupOperationStatuses

  • GETBackupOperationStatuses_Get/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupOperations/:operationId?api-version=stringGets the status of an operation such as triggering a backup or restore. The status can be In progress, Completed or Failed. You can refer to the…

ProtectionPolicies

  • GETProtectionPolicies_List/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupPolicies?api-version=string&$filter=stringLists the backup policies associated with the Recovery Services vault. The API provides parameters to Get scoped results.
  • GETProtectionPolicies_Get/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupPolicies/:policyName?api-version=stringGets the details of the backup policy associated with the Recovery Services vault. This is an asynchronous operation. Use the GetPolicyOperationResult API to…
  • PUTProtectionPolicies_CreateOrUpdate/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupPolicies/:policyName?api-version=stringCreates or modifies a backup policy. This is an asynchronous operation. Use the GetPolicyOperationResult API to Get the operation status.
  • DELETEProtectionPolicies_Delete/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupPolicies/:policyName?api-version=stringDeletes the specified backup policy from your Recovery Services vault. This is an asynchronous operation. Use the GetPolicyOperationResult API to Get the…

ProtectionPolicyOperationResults

  • GETProtectionPolicyOperationResults_Get/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupPolicies/:policyName/operationResults/:operationId?api-version=stringProvides the result of an operation.

ProtectionPolicyOperationStatuses

  • GETProtectionPolicyOperationStatuses_Get/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupPolicies/:policyName/operations/:operationId?api-version=stringProvides the status of the asynchronous operations like backup or restore. The status can be: in progress, completed, or failed. You can refer to the…

ProtectableItems

  • GETProtectableItems_List/Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupProtectableItems?api-version=string&$filter=string&$skipToken=stringBased on the query filter and the pagination parameters, this operation provides a pageable list of objects within the subscription that can be protected.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
33 operations on 29 pathsGET 22POST 7PUT 2DELETE 2
Main resources
ProtectedItems 4ProtectionPolicies 4ProtectionContainers 3ItemLevelRecoveryConnections 2Jobs 2RecoveryPoints 2BackupEngines 1BackupOperationResults 1BackupOperationStatuses 1Backups 1
Response formats
application/json
Description format
Swagger 2.0, API version 2016-06-01
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the RecoveryServicesBackupClient: Recoveryservicesbackup 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 RecoveryServicesBackupClient: Recoveryservicesbackup 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 “BackupEngines_Get” (GET /Subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupEngines?api-version=string&$filter=string&$skipToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the RecoveryServicesBackupClient: Recoveryservicesbackup?

RecoveryServicesBackupClient endpoints from Microsoft Azure It is listed under Developer tools and has 33 endpoints.

Who publishes the RecoveryServicesBackupClient: Recoveryservicesbackup?

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 RecoveryServicesBackupClient: Recoveryservicesbackup?

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

How do I authenticate with the RecoveryServicesBackupClient: Recoveryservicesbackup?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the RecoveryServicesBackupClient: Recoveryservicesbackup have?

33 operations on 29 paths (22 GET, 7 POST, 2 PUT, 2 DELETE). The largest groups are ProtectedItems, ProtectionPolicies, ProtectionContainers, ItemLevelRecoveryConnections.

Is forking the RecoveryServicesBackupClient: Recoveryservicesbackup 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.