The following REST APIs are available with VMware Live Site Recovery 9.0.
VMware Live Site Recovery Authentication APIs
| Category | Operation Type | REST API Name | Description |
|---|---|---|---|
| Authentication | GET | Get Current Session | Returns information about the current session, if any. |
| Authentication | POST | Login | Logs in and returns the session ID. In the subsequent requests, include the ‘x-dr-session’ header with the returned session ID value. |
| Authentication | DELETE | Logout | Logs out if the session is authenticated. |
VMware Live Site Recovery Inventory Mappings REST APIs
| Category | Operation Type | REST API Name | Description |
|---|---|---|---|
| Inventory Mappings | POST | Create Folder Mapping | Add folder mappings for a VMware Live Site Recovery in a given pairing. |
| Inventory Mappings | POST | Create Network Mapping | Add network mappings for a VMware Live Site Recovery in a given pairing. |
| Inventory Mappings | POST | Create Placeholder Datastores | Add placeholder datastores for a VMware Live Site Recovery in a given pairing. |
| Inventory Mappings | POST | Create Resource Mapping | Add resource mappings for a VMware Live Site Recovery in a given pairing. |
| Inventory Mappings | POST | Create Storage Policy Mapping | Add storage policy mappings for a VMware Live Site Recovery in a given pairing. |
| Inventory Mappings | POST | Create Test Network Mappings | Add test network mappings for a VMware Live Site Recovery in a given pairing. |
| Inventory Mappings | DELETE | Delete Folder Mapping | Delete a configured folder mapping for a VMware Live Site Recovery in a given pairing. |
| Inventory Mappings | DELETE | Delete Network Mapping | Delete a configured network mapping for a VMware Live Site Recovery in a given pairing. |
| Inventory Mappings | DELETE | Delete Placeholder Datastores | Delete a configured placeholder datastore for a VMware Live Site Recovery in a given pairing. |
| Inventory Mappings | DELETE | Delete Resource Mapping | Delete a configured resource mapping for a VMware Live Site Recovery in a given pairing |
| Inventory Mappings | DELETE | Delete Storage Policy Mapping | Delete a configured storage policy mapping for a VMware Live Site Recovery in a given pairing. |
| Inventory Mappings | DELETE | Delete Test Network Mappings | Delete a configured test network mappings for a VMware Live Site Recovery in a given pairing. |
| Inventory Mappings | GET | Get Folder Mapping | Get details about a configured folder mapping for a VMware Live Site Recovery in a given pairing. |
| Inventory Mappings | GET | Get Folder Mappings | Get currently configured folder mappings for a VMware Live Site Recovery in a given pairing. |
| Inventory Mappings | GET | Get Network IP Subnet Mapping | Get details about a configured IP subnet mapping for a network mapping. |
| Inventory Mappings | GET | Get Network Mapping | Get details about a configured network mapping for a VMware Live Site Recovery in a given pairing. |
| Inventory Mappings | GET | Get Network Mappings | Get currently configured network mappings for a VMware Live Site Recovery in a given pairing. |
| Inventory Mappings | GET | Get Placeholder Datastore | Get details about a configured placeholder datastore for a VMware Live Site Recovery in a given pairing. |
| Inventory Mappings | GET | Get Placeholder Datastores | Get currently configured placeholder datastores for a VMware Live Site Recovery in a given pairing. |
| Inventory Mappings | GET | Get Resource Mapping | Get details about a configured resource mapping for a VMware Live Site Recovery in a given pairing. |
| Inventory Mappings | GET | Get Resource Mappings | Get currently configured resource mappings for a VMware Live Site Recovery in a given pairing. |
| Inventory Mappings | GET | Get Storage Policy Mapping | Get details about a configured storage policy mapping for a VMware Live Site Recovery in a given pairing. |
| Inventory Mappings | GET | Get Storage Policy Mappings | Get currently configured storage policy mappings for a VMware Live Site Recovery in a given pairing. |
| Inventory Mappings | GET | Get Test Network Mapping | Get details about a configured test network mappings for a VMware Live Site Recovery in a given pairing. |
| Inventory Mappings | GET | Get Test Network Mappings | Get currently configured test network mappings for a VMware Live Site Recovery in a given pairing. |
| Inventory Mappings | POST | Query Suitable Datastores | Query for suitable datastores to be used as placeholder datastores. |
| Inventory Mappings | DELETE | Remove Network IP Subnet Mapping | Delete configured IP subnet mapping for a network mapping. |
| Inventory Mappings | PUT | Update Network IP Subnet Mapping | Create or update IP subnet mapping for a network mapping. |
VMware Live Site Recovery Site Pairing REST APIs
| Category | Operation Type | REST API Name | Description |
|---|---|---|---|
| Pairing | POST | Create Pairing | Pair to remote VMware Live Site Recovery server. |
| Pairing | DELETE | Delete Pairing | Delete existing pairing with remote VMware Live Site Recovery server. |
| Pairing | POST | Reconnect Pairing | Reconnect existing pairing to remote VMware Live Site Recovery server. |
| Pairing | POST | Create Remote Session | Create session to remote VMware Live Site Recovery server. |
| Pairing | GET | Get Pairing | Get information about the pairing. |
| Pairing | GET | Get Pairing Issues | Get all issues for the pairing. |
| Pairing | GET | Get Pairings | Get a list of all existing pairings. |
| Pairing | GET | Get Remote Session | Return information about the current session to the remote VMware Live Site Recovery server, if any. |
| Pairing | GET | Get SRM | Get information about a VMware Live Site Recovery server, which is part of a given pairing. |
| Pairing | GET | Get SRM Issues | Get a list of all VMware Live Site Recovery server issues for a given VMware Live Site Recovery server. |
| Pairing | GET | Get SRMs | Get a list of all VMware Live Site Recovery servers in the pairing. |
VMware Live Site Recovery Protection REST APIs
| Category | Operation Type | REST API Name | Description |
|---|---|---|---|
| Protection | GET | Get SRM Protection Inventory | Get information about VMware Live Site Recovery server protection inventory. |
| Protection | POST | Create Protection Group Folder | Create VMware Live Site Recovery protection group folder. |
| Protection | GET | Get Protection Group Folder Information | Get information about VMware Live Site Recovery protection group folder. |
| Protection | DELETE | Delete Protection Group Folder | Remove VMware Live Site Recovery protection group folder. |
| Protection | POST | Move Protection Group Folder | Move VMware Live Site Recovery protection group folder. |
| Protection | POST | Rename Protection Group Folder | Rename VMware Live Site Recovery protection group folder. |
| Protection | GET | Get SRM Protection Group Folder Children | Get information about VMware Live Site Recovery protection group folder children. |
| Protection | POST | Add Datastore Group | Add a replicated datastore group to a protection group in a given pairing. |
| Protection | POST | Configure All | Configure protection for all virtual machines, which are part of the protection group in a given pairing. |
| Protection | POST | Create Group | Create a new protection group in a given pairing. |
| Protection | DELETE | Delete Group | Delete a protection group in a given pairing. |
| Protection | GET | Get All Groups | Get information about all protection groups in a given pairing. |
| Protection | GET | Get Datastore Group | Get details about a replicated datastore group for a protection group in a given pairing. |
| Protection | GET | Get Datastore Groups | Get a list of replicated datastore groups for a protection group in a given pairing. |
| Protection | GET | Get Group | Get information about a protection group in a given pairing. |
| Protection | GET | Get Group Issues | Get issues about a protection group in a given pairing. |
| Protection | GET | Get Group Related Recovery Plans | Get recovery plans of which the protection group is part of. |
| Protection | GET | Get Group VM | Get details about a protected virtual machine that is part of a protection group in a given pairing. |
| Protection | GET | Get Group VMS | Get a list of virtual machines that are part of a protection group in a given pairing. |
| Protection | GET | Get VM Protection Settings | Get details about the current protection settings of a virtual machine. |
| Protection | GET | Get vVol Replication Group | Get information about the source Virtual Volumes replication group for a protection group in a given pairing. |
| Protection | GET | Get vVol Replication Groups | Get the source Virtual Volumes replication groups for a protection group in a given pairing. |
| Protection | POST | Reconfigure Group | Reconfigure settings for a protection group in a given pairing. |
| Protection | DELETE | Remove Datastore Group | Remove a replicated datastore group from a protection group in a given pairing. |
| Protection | POST | Remove VM From Protection Group | Remove a virtual machine from a vSphere Replication protection group in a given pairing. |
| Protection | POST | Remove VM Protection | Remove the protection of a virtual machine within a protection group in a given pairing. |
| Protection | POST | Restore All Placeholders | Repair all placeholder virtual machines that are part of the protection group in a given pairing. |
| Protection | PUT | Update VM Protection Settings | Update the protection settings of a virtual machine. |
VMware Live Site Recovery Recovery REST APIs
| Category | Operation Type | REST API Name | Description |
|---|---|---|---|
| Recovery | POST | Cancel Recovery Plan | Cancel a running recovery task. |
| Recovery | POST | Create Plan | Create a new recovery plan in a given pairing. |
| Recovery | DELETE | Delete recovery Plan | Delete a recovery plan from a given pairing. |
| Recovery | GET | Get All Plan History Records | Get a list of all history reports for recovery runs in a given timeframe in a given pairing. |
| Recovery | GET | Get All Recovery Plans | Get a list of all recovery plans in a given pairing. |
| Recovery | GET | Get Plan History Record | Get information about the history report for a recovery run of a recovery plan in a given pairing. |
| Recovery | GET | Get Plan History Records | Get a list of all history reports for recovery runs in a given timeframe of a recovery plan in a given pairing. |
| Recovery | GET | Get Plan Related Protection Groups | Get protection groups that are part of a recovery plan in a given pairing. |
| Recovery | GET | Get Plan Related Test Networks | Get the test networks configured for a recovery plan in a given pairing. |
| Recovery | GET | Get Plan Virtual Machine | Get the protected virtual machine included in a recovery plan in a given pairing. |
| Recovery | GET | Get Plan Virtual Machine Dependent VMS | Get the dependent VMs for a protected virtual machine. |
| Recovery | GET | Get Plan Virtual Machine IP Customization | Get the IP customization for a protected virtual machine. |
| Recovery | GET | Get Plan Virtual Machine Recovery Priority | Get the protected virtual machine priority during a recovery. |
| Recovery | GET | Get Plan Virtual Machine Recovery Settings | Get recovery settings for a protected virtual machine. |
| Recovery | GET | Get Plan Virtual Machine Summarized Recovery Settings | Get a summary of the recovery settings for a protected virtual machine. |
| Recovery | GET | Get Plan Virtual Machines | Get virtual machines that are part of a recovery plan in a given pairing. |
| Recovery | GET | Get Recovery Plan | Get information about a recovery plan in a given pairing. |
| Recovery | GET | Get Recovery Plan Issues | Get issues about a recovery plan in a given pairing. |
| Recovery | POST | Plan Virtual Machine Check Dependent VMS | Check if a given list of dependent VMs is valid against the current VM. |
| Recovery | POST | Reconfigure Recovery Plan | Reconfigure settings for a recovery in a given pairing. |
| Recovery | POST | Run Cleanup Test Recovery | Run a cleanup after a test recovery for a recovery plan in a given pairing. |
| Recovery | POST | Run Recovey | Run the recovery for a recovery plan in a given pairing. |
| Recovery | POST | Run Reprotect | Run the reprotect operation after a successful recovery for a recovery plan in a given pairing. |
| Recovery | POST | Run Test Recovery | Run a test recovery for a recovery plan in a given pairing. |
| Recovery | POST | Update Plan Virtual Machine Dependent VMS | Update the dependent VMs of a protected virtual machine. |
| Recovery | POST | Update Plan Virtual Machine IP Customization | Update the IP customization for a protected virtual machine. |
| Recovery | PUT | Update Plan Virtual Machine Recovery Priority | Update the recovery priority of a protected virtual machine. |
| Recovery | POST | Update Plan Virtual Machine Recovery Settings | Update recovery settings for a protected virtual machine. |
| Recovery | GET | Get SRM Recovery Inventory | Get information about VMware Live Site Recovery server recovery inventory. |
| Recovery | GET | Get SRM Recovery Plan Folder Information | Get information about VMware Live Site Recovery recovery plan folder. |
| Recovery | DELETE | Delete Recovery Plan Folder | Delete VMware Live Site Recovery recovery plan folder. |
| Recovery | POST | Move Recovery Plan Folder | Move VMware Live Site Recovery recovery plan folder. |
| Recovery | POST | Rename Recovery Plan Folder | Rename VMware Live Site Recovery recovery plan folder. |
| Recovery | POST | Create Recovery Plan Folder | Create VMware Live Site Recovery recovery plan folder. |
| Recovery | GET | Get SRM Recovery Folder Children | Get information about VMware Live Site Recovery recovery plan folder children. |
| Recovery | GET | Get All User Prompts | Get a list of all user prompts currently waiting for an acknowledgment. |
| Recovery | GET | Get User Prompt Details | Get information about a given user prompt currently waiting for an acknowledgment. |
| Recovery | POST | Dismiss Prompt | Dismiss a given user prompt waiting for a client acknowledgment during a recovery operation. |
| Recovery | GET | Get All Recovery Steps | Get information about recovery steps in a given recovery view mode. |
| Recovery | POST | Create Recovery Step Callout/Prompt | Add a callout/prompt to the list of recovery steps in a given recovery view mode. |
| Recovery | GET | Get Recovery Step Details | Get information about a recovery step in a given recovery view mode. |
| Recovery | DELETE | Delete Recovery Step Callout/Prompt | Delete a recovery step callout/prompt in a given recovery view mode. |
| Recovery | GET | Get Recovery Step Callout Details | Get data about a callout/prompt related to a given recovery step in a given recovery view mode. |
| Recovery | POST | Edit Recovery Step Callout/Prompt | Modify a callout/prompt to the list of recovery steps in a given recovery view mode. |
VMware Live Site Recovery Replication REST APIs
| Category | Operation Type | REST API Name | Description |
|---|---|---|---|
| Replication | GET | Get All vVol Fault Domain Replication Groups | Get information about all replication groups that are part of a VMware vSphere Virtual Volumes fault domain. |
| Replication | GET | Get All vVol Fault Domains | Get information about all VMware vSphere Virtual Volumes fault domains that are part of a given pairing. |
| Replication | GET | Get Replicated Array Pair | Get information about a replicated array pair that is part of a given pairing. |
| Replication | GET | Get Replicated Array Pairs | Get information about replicated array pairs that are part of a given pairing. |
| Replication | GET | Get vVol Fault Domain | Get details about a VMware vSphere Virtual Volumes fault domain that is part of a given pairing. |
| Replication | GET | Get vVol Fault Domain Replication Group | Get information about a replication group that is part of a VMware vSphere Virtual Volumes fault domain. |
| Replication | POST | Retrieve Unassigned Datastore Groups | Retrieve the unassigned datastore groups that are part of a replicated array pair. These datastore groups could be included in the Array-Based Replication protection groups. |
| Replication | GET | Get Array Managers | Get information about all VMware Live Site Recovery array managers. |
| Replication | POST | Create Array Managers | Create a VMware Live Site Recovery array manager. |
| Replication | GET | Get Array Manager | Get information about a VMware Live Site Recovery array manager. |
| Replication | DELETE | Delete Array Manager | Delete a VMware Live Site Recovery array manager. |
| Replication | POST | Discover Replicated Array Pairs | Discover storage arrays configured for replication by executing SRA command discoverArrays. |
| Replication | POST | Create Replicated Array Pair | Create a VMware Live Site Recovery replicated array pair. |
| Replication | DELETE | Delete Replicated Array Pair | Delete a VMware Live Site Recovery replicated array pair. |
| Replication | POST | Discover Replicated Array Pair Storage Devices | Discover storage devices and consistency groups of a VMware Live Site Recovery replicated array pair. |
| Replication | GET | Get Replicated Array Pair Storage Devices | Get information about all storage devices of a VMware Live Site Recovery replicated array pair. |
| Replication | GET | Get Storage Adapters | Get information about all storage replication adapters of a VMware Live Site Recovery. |
| Replication | GET | Get Storage Adapter | Get information about a storage replication adapter of a VMware Live Site Recovery. |
| Replication | GET | Get Storage Adapters Connection Params | Get connection parameters for a storage replication adapter of a VMware Live Site Recovery. |
VMware Live Site Recovery Server REST APIs
| Category | Operation Type | REST API Name | Description |
|---|---|---|---|
| Server | GET | Get Info | Information about the current Site Recovery Manager server. |
VMware Live Site Recovery Tasks REST APIs
| Tasks | GET | Get Recent Tasks Info | Retrieve all the recent tasks. |
| Tasks | GET | Get Task Info | Retrieve the task information. |
VMware Live Site Recovery vCenter Related REST APIs
| Category | Operation Type | REST API Name | Description |
|---|---|---|---|
| vCenter | GET | Get Replicated VMS | Get a list of VMs replicated by vSphere Replication in a given vCenter Server. |
| vCenter | GET | Get VC Storage Policies | Retrieve the storage policies of the vCenter Server. |
| vCenter | GET | Get VC Storage Policy | Get information about the storage policy objects of the vCenter Server. |
| vCenter | GET | Get vCenter | Get information about a vCenter Server that is part of a given pairing. |
| vCenter | GET | Get vCenters | Get a list of all vCenter Server instances in the pairing. |
| vCenter | GET | Get vCenter Compute Inventory | Get information about the compute inventory of the vCenter Server. |
| vCenter | GET | Get vCenter Compute Item | Get information about the compute object of the vCenter Server. |
| vCenter | GET | Get vCenter Datastore Item | Get information about the datastore object of the vCenter Server. |
| vCenter | GET | Get vCenter Datastores | Get information about the datastores of the vCenter Server. |
| vCenter | GET | Get vCenter Network Inventory | Get information about the network inventory of the vCenter Server. |
| vCenter | GET | Get vCenter Network Item | Get information about the network object of the vCenter Server. |
| vCenter | GET | Get vCenter VM Folder | Get information about the VM folder object of the vCenter Server. |
| vCenter | GET | Get vCenter VM Folder Inventory | Get information about the VM folder inventory of the vCenter Server. |
| vCenter | GET | Browse vCenter Compute Resource | Browse files and folders accessible to vCenter Server's compute object. |
