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 Remote Session
Creates a session to the 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.
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.
DELETE
Delete Group
Delete a protection group in a given pairing.
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 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
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
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.
DELETE
Delete Recovery Plan
Delete a recovery plan from a given pairing.
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 Machines
Get virtual machines that are part of a recovery plan in a given pairing.
GET
Get Plan Virtual Machine Summarized Recovery Settings
Get a summary of the recovery settings for a protected virtual machine.
GET
Get Recovery Plan
Get information about a recovery plan in a given pairing.
GET
Get Recovery Plan Issues
Get issues about a recovery plan in a given pairing.
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
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
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 Replicated Array Pair
Get information about a replicated array pair that is part of a given pairing.
GET
Get Replicated Array Pairs
Get information about replicated array pairs that are part of a given pairing.
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. These datastore groups could be included 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
Get Replicated Vms
Get a list of VMs replicated by vSphere Replication in a given vCenter Server.
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 Vcenters
Get a list of all vCenter Server instances in the pairing.
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 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.