VMware Site Recovery Manager REST API Gateway Operations Index

All available VMware Site Recovery Manager REST API Gateway Operations.

---

Authentication

get	Get Current Session Returns information about the current session, if any.
post	Login Logs in and returns the session ID. In the subsequent requests, include the 'x-dr-session' header with the value of the returned session ID.
delete	Logout Logs out if the session is authenticated.

---

Inventory Mappings

post	Create Folder Mapping Add folder mappings for an SRM in a given pairing.
post	Create Network Mapping Add network mappings for an SRM in a given pairing.
post	Create Placeholder Datastores Add placeholder datastores for an SRM in a given pairing.
post	Create Resource Mapping Add resource mappings for an SRM in a given pairing.
post	Create Storage Policy Mapping Add storage policy mappings for an SRM in a given pairing.
post	Create Test Network Mappings Add test network mappings for an SRM in a given pairing.
delete	Delete Folder Mapping Delete a configured folder mapping for an SRM in a given pairing.
delete	Delete Network Mapping Delete a configured network mapping for an SRM in a given pairing.
delete	Delete Placeholder Datastore Delete a configured placeholder datastore for an SRM in a given pairing.
delete	Delete Resource Mapping Delete a configured resource mapping for an SRM in a given pairing.
delete	Delete Storage Policy Mapping Delete a configured storage policy mapping for an SRM in a given pairing.
delete	Delete Test Network Mapping Delete a configured test network mapping for an SRM in a given pairing.
get	Get Folder Mapping Get details about a configured folder mapping for an SRM in a given pairing.
get	Get Folder Mappings Get currently configured folder mappings for an SRM in a given pairing.
get	Get Network IP Subnet Mapping Get details about a configured IP subnet mapping for a network mapping.
get	Get Network Mapping Get details about a configured network mapping for an SRM in a given pairing.
get	Get Network Mappings Get currently configured network mappings for an SRM in a given pairing.
get	Get Placeholder Datastore Get details about a configured placeholder datastore for an SRM in a given pairing.
get	Get Placeholder Datastores Get currently configured placeholder datastores for an SRM in a given pairing.
get	Get Resource Mapping Get details about a configured resource mapping for an SRM in a given pairing.
get	Get Resource Mappings Get currently configured resource mappings for an SRM in a given pairing.
get	Get Storage Policy Mapping Get details about a configured storage policy mapping for an SRM in a given pairing.
get	Get Storage Policy Mappings Get currently configured storage policy mappings for an SRM in a given pairing.
get	Get Test Network Mapping Get details about a configured test network mappings for an SRM in a given pairing.
get	Get Test Network Mappings Get currently configured test network mappings for an SRM in a given pairing.
post	Query Suitable Datastores A query for suitable datastores to be used as placeholder datastores.
delete	Remove Network IP Subnet Mapping Delete the configured IP subnet mapping for a network mapping.
put	Update Network IP Subnet Mapping Create or update the IP subnet mapping for a network mapping.

---

Pairing

post	Create Pairing Pair to remote Site Recovery Manager server.
post	Create Remote Session Creates a session to the remote Site Recovery Manager server.
delete	Delete Pairing Delete existing pairing with remote Site Recovery Manager server.
get	Get Pairing Get information about the pairing.
get	Get Pairing Issues Get all issues for the pairing.
get	Get Pairings Get a list of all existing pairings.
get	Get Remote Session Returns information about the current session to the remote Site Recovery Manager server, if any.
get	Get SRM Get information about a Site Recovery Manager server, which is part of a given pairing.
get	Get SRM Issues Get a list of all Site Recovery Manager server issues for a given Site Recovery Manager server.
get	Get SRMs Get a list of all Site Recovery Manager servers in the pairing.
post	Reconnect Pairing Reconnect existing pairing to remote Site Recovery Manager server.

---

Protection

post	Add Datastore Group Add a replicated datastore group to a protection group in a given pairing.
post	Configure All Configure protection for all virtual machines that are part of the protection group in a given pairing.
post	Create Group Create a new protection group in a given pairing.
post	Create Protection Group Folder Create Site Recovery Manager protection group folder.
delete	Delete Group Delete a protection group in a given pairing.
delete	Delete Protection Group Folder Remove Site Recovery Manager protection group folder.
get	Get All Groups Get information about all protection groups in a given pairing.
get	Get Datastore Group Get details about a replicated datastore group of a protection group in a given pairing.
get	Get Datastore Groups Get a list of replicated datastore groups for a protection group in a given pairing.
get	Get Group Get information about a protection group in a given pairing.
get	Get Group Issues Get issues about a protection group in a given pairing.
get	Get Group Related Recovery Plans Get recovery plans in which the protection group is part of.
get	Get Group VM Get details about a protected virtual machine that is part of a protection group in a given pairing.
get	Get Group VMS Get a list of virtual machines that are part of a protection group in a given pairing.
get	Get Protection Group Folder Get information about Site Recovery Manager protection group folder.
get	Get Protection Group Folder Children Get information about Site Recovery Manager protection group folder children.
get	Get Protection Group Folders Get information about Site Recovery Manager server protection inventory.
get	Get VM Protection Settings Get details about the current protection settings of a virtual machine.
get	Get vVol Replication Group Get information about the source vSphere Virtual Volumes (vVols) replication group for a protection group in a given pairing.
get	Get vVol Replication Groups Get the source VVOL replication groups for a protection group in a given pairing.
post	Move Protection Group Folder Move Site Recovery Manager protection group folder.
post	Reconfigure Group Reconfigure settings for a protection group in a given pairing.
delete	Remove Datastore Group Remove a replicated datastore group from a protection group in a given pairing.
post	Remove VM From Protection Group Remove a virtual machine from a VR protection group in a given pairing.
post	Remove VM Protection Remove the protection of a virtual machine within a protection group in a given pairing.
post	Rename Protection Group Folder Rename Site Recovery Manager protection group folder.
post	Restore All Placeholders Repair all placeholder virtual machines that are part of the protection group in a given pairing.
put	Update VM Protection Settings Update the protection settings of a virtual machine.

---

Recovery

post	Cancel Recovery Plan Cancels a running recovery task.
post	Create Plan Create a new recovery plan in a given pairing.
post	Create Recovery Plan Folder Create Site Recovery Manager recovery plan folder.
post	Create Recovery Steps Callout Add a callout/prompt to the list of recovery steps in a given recovery view mode.
delete	Delete Recovery Plan Delete a recovery plan from a given pairing.
delete	Delete Recovery Plan Folder Delete Site Recovery Manager recovery plan folder.
delete	Delete Recovery Step Delete a recovery step in a given recovery view mode.
post	Dismiss Recovery Steps Recovery Plan Prompt Dismiss a given user prompt waiting for a client acknowledgment during a recovery operation.
post	Edit Recovery Steps Callout Modify a callout/prompt to the list of recovery steps in a given recovery view mode.
get	Get All Plan History Records Get a list of all history reports for recovery runs in a given timeframe in a given pairing.
get	Get All Recovery Plans Get a list of all recovery plans in a given pairing.
get	Get Plan History Record Get information about the history report for a recovery run of a recovery plan in a given pairing.
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.
get	Get Plan Related Protection Groups Get protection groups that are part of a recovery plan in a given pairing.
get	Get Plan Related Test Networks Get the test networks configured for a recovery plan in a given pairing.
get	Get Plan Virtual Machine Get the protected virtual machine included in a recovery plan in a given pairing.
get	Get Plan Virtual Machine Dependent VMS Get the dependent VMs for a protected virtual machine.
get	Get Plan Virtual Machine IP Customization Get the IP customization for a protected virtual machine.
get	Get Plan Virtual Machine Recovery Priority Get the protected virtual machine priority during a recovery.
get	Get Plan Virtual Machine Recovery Settings Get recovery settings for a protected virtual machine.
get	Get Plan Virtual Machine Summarized Recovery Settings Get a summary of the recovery settings for a protected virtual machine.
get	Get Plan Virtual Machines Get virtual machines that are part of a recovery plan in a given pairing.
get	Get Recovery Plan Get information about a recovery plan in a given pairing.
get	Get Recovery Plan Folder Get information about Site Recovery Manager recovery plan folder.
get	Get Recovery Plan Folder Children Get information about Site Recovery Manager recovery plan folder children.
get	Get Recovery Plan Folders Get information about Site Recovery Manager server recovery inventory.
get	Get Recovery Plan Issues Get issues about a recovery plan in a given pairing.
get	Get Recovery Step Get information about a recovery step in a given recovery view mode.
get	Get Recovery Steps Get information about recovery steps in a given recovery view mode
get	Get Recovery Steps Callout Details Get data about a callout/prompt related to a given recovery step in a given recovery view mode.
get	Get Recovery Steps User Prompt Get information about a given user prompt currently waiting for an acknowledgment.
get	Get Recovery Steps User Prompts Get a list of all user prompts currently waiting for an acknowledgment.
post	Move Recovery Plan Folder Move Site Recovery Manager recovery plan folder.
post	Plan Virtual Machine Check Dependent VMS Checks if a given list of dependent VMs is valid against the current VM.
post	Reconfigure Recovery Plan Reconfigure settings for a recovery in a given pairing.
post	Rename Recovery Plan Folder Rename Site Recovery Manager recovery plan folder.
post	Run Cleanup Test Recovery Run a cleanup after a test recovery for a recovery plan in a given pairing.
post	Run Recovery Run the recovery for a recovery plan in a given pairing.
post	Run Reprotect Run the reprotect operation after a successful recovery for a recovery plan in a given pairing.
post	Run Test Recovery Run a test recovery for a recovery plan in a given pairing.
post	Update Plan Virtual Machine Dependent VMS Update the dependent VMs of a protected virtual machine.
post	Update Plan Virtual Machine IP Customization Update the IP customization for a protected virtual machine.
put	Update Plan Virtual Machine Recovery Priority Update the recovery priority of a protected virtual machine.
post	Update Plan Virtual Machine Recovery Settings Update recovery settings for a protected virtual machine.

---

Replication

post	Create Array Manager Create a Site Recovery Manager array manager.
post	Create Replicated Array Pair Create a Site Recovery Manager replicated array pair.
delete	Delete Array Manager Delete a Site Recovery Manager array manager.
delete	Delete Replicated Array Pair Delete a Site Recovery Manager replicated array pair.
post	Discover Replicated Array Pairs Discovers storage arrays configured for replication by executing SRA command discoverArrays.
post	Discover Storage Devices Discover storage devices and consistency groups of a Site Recovery Manager replicated array pair.
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.
get	Get All vVol Fault Domains Get information about all VMware vSphere Virtual Volumes (vVols) fault domains that are part of a given pairing.
get	Get Array Manager Get information about a Site Recovery Manager array manager.
get	Get Array Managers Get information about all Site Recovery Manager array managers.
get	Get Replicated Array Pair Get information about a Site Recovery Manager replicated array pair.
get	Get Replicated Array Pairs Get information about all Site Recovery Manager replicated array pairs.
get	Get Storage Adapter Get information about a storage replication adapter of a Site Recovery Manager.
get	Get Storage Adapter Connection Params Get connection parameters for a storage replication adapter of a Site Recovery Manager.
get	Get Storage Adapters Get information about all storage replication adapters of a Site Recovery Manager.
get	Get Storage Devices Get information about all storage devices of a Site Recovery Manager replicated array pair.
get	Get vVol Fault Domain Get details about a VMware vSphere Virtual Volumes (vVols) fault domain that is part of a given pairing.
get	Get vVol Fault Domain Replication Group Get information about a replication group that is part of a VMware Virtual Volumes fault domain.
post	Retrieve Unassigned Datastore Groups Retrieve the unassigned datastore groups that are part of a replicated array pair. You can include these datastore groups in the Array-Based Replication protection groups.

---

Server

get	Get Info Information about the current Site Recovery Manager server.

---

Tasks

get	Get Recent Tasks Info Retrieve all the recent tasks.
get	Get Task Info Retrieve the task information.

---

vCenters

get	Browse vCenter Compute Item Browse files and folders accessible to vCenter server's compute object.
get	Get Replicated VMS Get a list of VMs replicated by vSphere Replication in a given vCenter Server.
get	Get VC Storage Policies Retrieve the vCenter Server's storage policies.
get	Get VC Storage Policy Get information about the vCenter Server's storage policy object.
get	Get vCenter Get information about a vCenter Server that is part of a given pairing.
get	Get vCenter Compute Inventory Get information about the vCenter Server's compute inventory.
get	Get vCenter Compute Item Get information about the vCenter Server's compute object.
get	Get vCenter Datastore Item Get information about the vCenter Server's datastore object.
get	Get vCenter Datastores Get information about the vCenter Server's datastores.
get	Get vCenter Network Inventory Get information about the vCenter Server's network inventory.
get	Get vCenter Network Item Get information about the vCenter Server's network object.
get	Get vCenter VM Folder Get information about the vCenter Server's VM folder object.
get	Get vCenter VM Folder Inventory Get information about the vCenter Server's VM folder inventory.
get	Get vCenters Get a list of all vCenter Server instances in the pairing.