Azure Site Recovery website screenshot

Azure Site Recovery

Azure Site Recovery REST API provides management of disaster recovery for Azure VMs, on-premises VMs, and physical servers. It supports configuring replication, running test failovers, executing planned and unplanned failovers, and managing recovery plans.

1 APIs 0 Features
Disaster RecoveryReplicationBusiness ContinuityFailover

APIs

Azure Site Recovery REST API

Azure Site Recovery REST API provides management of disaster recovery for Azure VMs, on-premises VMs, and physical servers. It supports configuring replication, running test fai...

Collections

Pricing Plans

Rate Limits

FinOps

Resources

👥
GitHubOrganization
GitHubOrganization
🌐
Portal
Portal
💰
Pricing
Pricing
🔗
Documentation
Documentation
🚀
GettingStarted
GettingStarted
🟢
StatusPage
StatusPage
📜
TermsOfService
TermsOfService
📜
PrivacyPolicy
PrivacyPolicy
💬
Support
Support
📰
Blog
Blog
👥
StackOverflow
StackOverflow
🔗
LlmsText
LlmsText

Sources

Raw ↑
opencollection: 1.0.0
info:
  name: Azure Site Recovery REST API
  version: '2026-02-01'
request:
  auth:
    type: oauth2
    flow: implicit
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
    credentials:
      clientId: '{{clientId}}'
items:
- info:
    name: ReplicationProtectedItems
    type: folder
  items:
  - info:
      name: List replication protected items by container
      type: http
    http:
      method: GET
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:resourceName/replicationFabrics/:fabricName/replicationProtectionContainers/:protectionContainerName/replicationProtectedItems
      params:
      - name: subscriptionId
        value: ''
        type: path
      - name: resourceGroupName
        value: ''
        type: path
      - name: resourceName
        value: ''
        type: path
        description: Name of the Recovery Services Vault
      - name: fabricName
        value: ''
        type: path
      - name: protectionContainerName
        value: ''
        type: path
      - name: api-version
        value: ''
        type: query
    docs: List replication protected items by container
  - info:
      name: Get a replication protected item
      type: http
    http:
      method: GET
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:resourceName/replicationFabrics/:fabricName/replicationProtectionContainers/:protectionContainerName/replicationProtectedItems/:replicatedProtectedItemName
      params:
      - name: subscriptionId
        value: ''
        type: path
      - name: resourceGroupName
        value: ''
        type: path
      - name: resourceName
        value: ''
        type: path
        description: Name of the Recovery Services Vault
      - name: fabricName
        value: ''
        type: path
      - name: protectionContainerName
        value: ''
        type: path
      - name: replicatedProtectedItemName
        value: ''
        type: path
      - name: api-version
        value: ''
        type: query
    docs: Get a replication protected item
  - info:
      name: Enable replication protection for an item
      type: http
    http:
      method: PUT
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:resourceName/replicationFabrics/:fabricName/replicationProtectionContainers/:protectionContainerName/replicationProtectedItems/:replicatedProtectedItemName
      params:
      - name: subscriptionId
        value: ''
        type: path
      - name: resourceGroupName
        value: ''
        type: path
      - name: resourceName
        value: ''
        type: path
        description: Name of the Recovery Services Vault
      - name: fabricName
        value: ''
        type: path
      - name: protectionContainerName
        value: ''
        type: path
      - name: replicatedProtectedItemName
        value: ''
        type: path
      - name: api-version
        value: ''
        type: query
      body:
        type: json
        data: '{}'
    docs: Enable replication protection for an item
  - info:
      name: Update replication protected item settings
      type: http
    http:
      method: PATCH
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:resourceName/replicationFabrics/:fabricName/replicationProtectionContainers/:protectionContainerName/replicationProtectedItems/:replicatedProtectedItemName
      params:
      - name: subscriptionId
        value: ''
        type: path
      - name: resourceGroupName
        value: ''
        type: path
      - name: resourceName
        value: ''
        type: path
        description: Name of the Recovery Services Vault
      - name: fabricName
        value: ''
        type: path
      - name: protectionContainerName
        value: ''
        type: path
      - name: replicatedProtectedItemName
        value: ''
        type: path
      - name: api-version
        value: ''
        type: query
      body:
        type: json
        data: '{}'
    docs: Update replication protected item settings
  - info:
      name: Disable protection for an item
      type: http
    http:
      method: DELETE
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:resourceName/replicationFabrics/:fabricName/replicationProtectionContainers/:protectionContainerName/replicationProtectedItems/:replicatedProtectedItemName
      params:
      - name: subscriptionId
        value: ''
        type: path
      - name: resourceGroupName
        value: ''
        type: path
      - name: resourceName
        value: ''
        type: path
        description: Name of the Recovery Services Vault
      - name: fabricName
        value: ''
        type: path
      - name: protectionContainerName
        value: ''
        type: path
      - name: replicatedProtectedItemName
        value: ''
        type: path
      - name: api-version
        value: ''
        type: query
    docs: Disable protection for an item
  - info:
      name: Execute planned failover
      type: http
    http:
      method: POST
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:resourceName/replicationFabrics/:fabricName/replicationProtectionContainers/:protectionContainerName/replicationProtectedItems/:replicatedProtectedItemName/plannedFailover
      params:
      - name: subscriptionId
        value: ''
        type: path
      - name: resourceGroupName
        value: ''
        type: path
      - name: resourceName
        value: ''
        type: path
        description: Name of the Recovery Services Vault
      - name: fabricName
        value: ''
        type: path
      - name: protectionContainerName
        value: ''
        type: path
      - name: replicatedProtectedItemName
        value: ''
        type: path
      - name: api-version
        value: ''
        type: query
      body:
        type: json
        data: '{}'
    docs: Execute planned failover
  - info:
      name: Execute test failover
      type: http
    http:
      method: POST
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:resourceName/replicationFabrics/:fabricName/replicationProtectionContainers/:protectionContainerName/replicationProtectedItems/:replicatedProtectedItemName/testFailover
      params:
      - name: subscriptionId
        value: ''
        type: path
      - name: resourceGroupName
        value: ''
        type: path
      - name: resourceName
        value: ''
        type: path
        description: Name of the Recovery Services Vault
      - name: fabricName
        value: ''
        type: path
      - name: protectionContainerName
        value: ''
        type: path
      - name: replicatedProtectedItemName
        value: ''
        type: path
      - name: api-version
        value: ''
        type: query
      body:
        type: json
        data: '{}'
    docs: Execute test failover
  - info:
      name: Execute unplanned failover
      type: http
    http:
      method: POST
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:resourceName/replicationFabrics/:fabricName/replicationProtectionContainers/:protectionContainerName/replicationProtectedItems/:replicatedProtectedItemName/unplannedFailover
      params:
      - name: subscriptionId
        value: ''
        type: path
      - name: resourceGroupName
        value: ''
        type: path
      - name: resourceName
        value: ''
        type: path
        description: Name of the Recovery Services Vault
      - name: fabricName
        value: ''
        type: path
      - name: protectionContainerName
        value: ''
        type: path
      - name: replicatedProtectedItemName
        value: ''
        type: path
      - name: api-version
        value: ''
        type: query
      body:
        type: json
        data: '{}'
    docs: Execute unplanned failover
  - info:
      name: Commit failover
      type: http
    http:
      method: POST
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:resourceName/replicationFabrics/:fabricName/replicationProtectionContainers/:protectionContainerName/replicationProtectedItems/:replicatedProtectedItemName/failoverCommit
      params:
      - name: subscriptionId
        value: ''
        type: path
      - name: resourceGroupName
        value: ''
        type: path
      - name: resourceName
        value: ''
        type: path
        description: Name of the Recovery Services Vault
      - name: fabricName
        value: ''
        type: path
      - name: protectionContainerName
        value: ''
        type: path
      - name: replicatedProtectedItemName
        value: ''
        type: path
      - name: api-version
        value: ''
        type: query
    docs: Commit failover
  - info:
      name: Reverse replication / reprotect
      type: http
    http:
      method: POST
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:resourceName/replicationFabrics/:fabricName/replicationProtectionContainers/:protectionContainerName/replicationProtectedItems/:replicatedProtectedItemName/reProtect
      params:
      - name: subscriptionId
        value: ''
        type: path
      - name: resourceGroupName
        value: ''
        type: path
      - name: resourceName
        value: ''
        type: path
        description: Name of the Recovery Services Vault
      - name: fabricName
        value: ''
        type: path
      - name: protectionContainerName
        value: ''
        type: path
      - name: replicatedProtectedItemName
        value: ''
        type: path
      - name: api-version
        value: ''
        type: query
      body:
        type: json
        data: '{}'
    docs: Reverse replication / reprotect
  - info:
      name: List all replication protected items in the vault
      type: http
    http:
      method: GET
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:resourceName/replicationProtectedItems
      params:
      - name: subscriptionId
        value: ''
        type: path
      - name: resourceGroupName
        value: ''
        type: path
      - name: resourceName
        value: ''
        type: path
        description: Name of the Recovery Services Vault
      - name: api-version
        value: ''
        type: query
    docs: List all replication protected items in the vault
- info:
    name: RecoveryPlans
    type: folder
  items:
  - info:
      name: List recovery plans
      type: http
    http:
      method: GET
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:resourceName/replicationRecoveryPlans
      params:
      - name: subscriptionId
        value: ''
        type: path
      - name: resourceGroupName
        value: ''
        type: path
      - name: resourceName
        value: ''
        type: path
        description: Name of the Recovery Services Vault
      - name: api-version
        value: ''
        type: query
    docs: List recovery plans
  - info:
      name: Get a recovery plan
      type: http
    http:
      method: GET
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:resourceName/replicationRecoveryPlans/:recoveryPlanName
      params:
      - name: subscriptionId
        value: ''
        type: path
      - name: resourceGroupName
        value: ''
        type: path
      - name: resourceName
        value: ''
        type: path
        description: Name of the Recovery Services Vault
      - name: recoveryPlanName
        value: ''
        type: path
      - name: api-version
        value: ''
        type: query
    docs: Get a recovery plan
  - info:
      name: Create or update a recovery plan
      type: http
    http:
      method: PUT
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:resourceName/replicationRecoveryPlans/:recoveryPlanName
      params:
      - name: subscriptionId
        value: ''
        type: path
      - name: resourceGroupName
        value: ''
        type: path
      - name: resourceName
        value: ''
        type: path
        description: Name of the Recovery Services Vault
      - name: recoveryPlanName
        value: ''
        type: path
      - name: api-version
        value: ''
        type: query
      body:
        type: json
        data: '{}'
    docs: Create or update a recovery plan
  - info:
      name: Delete a recovery plan
      type: http
    http:
      method: DELETE
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:resourceName/replicationRecoveryPlans/:recoveryPlanName
      params:
      - name: subscriptionId
        value: ''
        type: path
      - name: resourceGroupName
        value: ''
        type: path
      - name: resourceName
        value: ''
        type: path
        description: Name of the Recovery Services Vault
      - name: recoveryPlanName
        value: ''
        type: path
      - name: api-version
        value: ''
        type: query
    docs: Delete a recovery plan
bundled: true