VMware Site Recovery Manager REST API Gateway Operations Index
All available VMware Site Recovery Manager REST API Gateway Operations
Returns information about the current session, if any.
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.
Logs out if the session is authenticated.
Get currently configured folder mappings for an SRM in a given pairing.
Add folder mappings for an SRM in a given pairing.
Get details about a configured folder mapping for an SRM in a given pairing.
Delete a configured folder mapping for an SRM in a given pairing.
Get currently configured network mappings for an SRM in a given pairing.
Add network mappings for an SRM in a given pairing.
Get details about a configured network mapping for an SRM in a given pairing.
Delete a configured network mapping for an SRM in a given pairing.
Get details about a configured IP subnet mapping for a network mapping.
Create or update the IP subnet mapping for a network mapping.
Delete the configured IP subnet mapping for a network mapping.
Get currently configured placeholder datastores for an SRM in a given pairing.
Add placeholder datastores for an SRM in a given pairing.
A query for suitable datastores to be used as placeholder datastores.
Get details about a configured placeholder datastore for an SRM in a given pairing.
Delete a configured placeholder datastore for an SRM in a given pairing.
Get currently configured resource mappings for an SRM in a given pairing.
Add resource mappings for an SRM in a given pairing.
Get details about a configured resource mapping for an SRM in a given pairing.
Delete a configured resource mapping for an SRM in a given pairing.
Get currently configured storage policy mappings for an SRM in a given pairing.
Add storage policy mappings for an SRM in a given pairing.
Get details about a configured storage policy mapping for an SRM in a given pairing.
Delete a configured storage policy mapping for an SRM in a given pairing.
Get currently configured test network mappings for an SRM in a given pairing.
Add test network mappings for an SRM in a given pairing.
Get details about a configured test network mappings for an SRM in a given pairing.
Delete a configured test network mapping for an SRM in a given pairing.
Get information about a VMware Live Site Recovery licensing.
Generate offline VMware Live Site Recovery activation request key, to be used in VMware Live Recovery Cloud Service to create offline VMware Live Site Recovery license key. Then the received license key must be applied to this server.
Apply offline VMware Live Site Recovery key, retrieved from VMware Live Recovery Cloud Service. VMware Live Site Recovery will be licensed to use only the number of VMs specified in the license key. To retrieve the offline license key you must generate activation request key and then use it in VMware Live Recovery Cloud Service.
Deactivate the offline VMware Live Site Recovery key if present. This API can be called even if the offline key has already been deactivated. Task result contains deactivation request key, which you must enter in VMware Live Recovery Cloud Service to free the license in the cloud.
Get a list of all existing pairings.
Pair to remote Site Recovery Manager server.
Get information about the pairing.
Delete existing pairing with remote Site Recovery Manager server.
Reconnect existing pairing to remote Site Recovery Manager server.
Get all issues for the pairing.
Returns information about the current session to the remote Site Recovery Manager server, if any.
Creates a session to the remote Site Recovery Manager server.
Get a list of all Site Recovery Manager servers in the pairing.
Get information about a Site Recovery Manager server, which is part of a given pairing.
Get a list of all Site Recovery Manager server issues for a given Site Recovery Manager server.
Get a list of all Site Recovery Manager server permissions for a given Site Recovery Manager object.
Adds or modifies a permission rule from a given Site Recovery Manager object.
DEPRECATED - use /pairings/{pairing_id}/srms/{srm_id}/permissions/actions/remove instead.
Removes a permission rule from a given Site Recovery Manager object.
Get information about all protection groups in a given pairing.
Create a new protection group in a given pairing.
Get information about a protection group in a given pairing.
Delete a protection group in a given pairing.
Configure protection for all virtual machines that are part of the protection group in a given pairing.
Empty list of tasks is returned when all virtual machines in the protection group are already protected.
Reconfigure settings for this group.
Repair placeholder VMs.
Called when the placeholder needs to be recreated due to one of these reasons:
- Placeholder creation failed.
- Placeholder was deleted.
- Placeholder inventory was lost or needs to be reentered - one use case for this is when production VM was a template but then gets converted to a VM.
This method can be called only on the recovery site. It does not require the primary site to be up for successful completion.
Empty list of tasks is returned when no virtual machines need repair of their placeholder VMs.
List of replicated datastore groups.
Each datastore group represents a minimal set of datastores that must be protected and recovered together.
The rules for combining datastores are:
- Datastores are backed by storage devices from the same consistency group.
- Virtual machine spans multiple datastores.
- Two virtual machines on two different datastores share an RDM device.
For non-Array-Based Replication protection group, this will return an empty response.
Add a replicated datastore group from an Array-Based Replication protection group. This operation also protects all VMs, including VMs residing on any datastore that is part of the newly added datastore group. For a non-Array-Based Replication protection group, this will return an empty response.
A group of replicated datastores.
A datastore group represents a minimal set of datastores that must be protected and recovered together.
The rules for combining datastores are:
- Datastores are backed by storage devices from the same consistency group.
- Virtual machine spans multiple datastores.
- Two virtual machines on two different datastores share an RDM device.
For a non-Array-Based Replication protection group, this will return an empty response.
Remove a replicated datastore group from an Array-Based Replication protection group. This operation also removes the protection of VMs residing on any datastore that is part of the removed datastore group.
Get issues about a protection group in a given pairing.
Get recovery plans in which the protection group is part of.
The source VVOL replication groups for this protection group. Both protection and recovery site report the same replication groups. For non-VVOL protection group, this will return an error response.
The source vSphere Virtual Volumes replication groups for this protection group. Both protection and recovery site report the same replication groups.
A list of details for virtual machines that are part of the protection group.
Details of a protected virtual machine that is part of the protection group.
Remove the virtual machine for a VR protection group
Remove the protection of a given virtual machine for this group. Once the protection of a VM is removed, the VM will not be recovered during recovery. To protect the VM again, run the configure protection operation.
Get details about the current protection settings of a virtual machine.
Update the protection settings of a virtual machine. This endpoint must be called after the remove protection operation in order for the VM to be recovered during recovery.
Get information about Site Recovery Manager server protection inventory.
Create a new sub-folder with the specified name.
Because of the dual-server nature of Site Recovery Manager, the sites must be connected when creating folders.
Any % (percent) character used in this name parameter must be escaped, unless it is used to start an escape sequence. Clients can also escape any other characters in this name parameter.
This method requires VcDr.ProtectionProfile.com.vmware.vcDr.Create privilege on the containing folder.
Get information about Site Recovery Manager protection group folder.
Remove Site Recovery Manager protection group folder.
Move a specified folder into a destination folder. This operation is typically used by clients when implementing a drag-and-drop interface for moving folders.
The objects that can be moved into a folder depend on the parent folder's type. You can move only recovery plans and recovery plan folders into a folder constructed for recovery plans. You can move only protection groups and protection group folders into a folder constructed for protection groups.
This method requires VcDr.ProtectionProfile.com.vmware.vcDr.Edit privilege on the moved folder and source and destination parent folders.
Rename Site Recovery Manager protection group folder.
Get information about Site Recovery Manager protection group folder children.
If no start_date and end_date are specified, then the last seven days of data will be returned.
Get information about Site Recovery Manager server recovery inventory.
Create a new sub-folder with the specified name.
Any % (percent) character used in this name parameter must be escaped, unless it is used to start an escape sequence. Clients can also escape any other characters in this name parameter.
This method requires VcDr.RecoveryProfile.com.vmware.vcDr.Create andVcDr.RecoveryProfile.com.vmware.vcDr.Edit privilege on the containing folder.
Get information about Site Recovery Manager recovery plan folder.
Delete the folder with the specified ID.VcDr.RecoveryProfile.com.vmware.vcDr.Delete privilege on the containing folder.
Move a specified folder into a destination folder. This operation is typically used by clients when implementing a drag-and-drop interface for moving folders.
The objects that can be moved into a folder depend on the parent folder's type. You can move only recovery plans and recovery plan folders into a folder constructed for recovery plans. You can move only protection groups and protection group folders into a folder constructed for protection groups.
This method requires VcDr.RecoveryProfile.com.vmware.vcDr.Edit privilege on the moved folder and the source and destination parent folders.
Rename a folder with the specified name.
Any % (percent) character used in this name parameter must be escaped, unless it is used to start an escape sequence. Clients can also escape any other characters in this name parameter.
This method requires VcDr.RecoveryProfile.com.vmware.vcDr.Create andVcDr.RecoveryProfile.com.vmware.vcDr.Edit privilege on the containing folder.
Get information about Site Recovery Manager recovery plan folder children.
Recovery plans are used for automating the recovery execution during a migration or a failover.
Create a new recovery plan in a given pairing.
Recovery plans are used for automating the recovery execution during a migration or a failover.
Delete a recovery plan from a given pairing.
Cancels a running recovery task for this recovery plan.
Run a cleanup test recovery for this recovery plan.
Reconfigure settings for this recovery plan.
Run the recovery for this recovery plan.
Run reprotect for this recovery plan. Complete a recovery, and start protecting the groups so they can be recovered on the peer site. Reprotect involves unregistering the VMs on the peer site, configuring storage, and registering placeholders. The callers must ensure that they have all the required privileges for VM creation, deletion, and reconfiguration.
Run a test recovery for this recovery plan, leaving the primary site unaffected.
If no start_date and end_date are specified, then the last seven days of data will be returned.
Get information about the history report for a recovery run of a recovery plan in a given pairing.
Get issues about a recovery plan in a given pairing.
Get protection groups that are part of a recovery plan in a given pairing.
User prompts are configurable callouts which are triggered during a recovery operation.
User prompts must be dismissed by the client in order the recovery operation to continue.
User prompts are configurable callouts which are triggered during a recovery operation.
User prompts must be dismissed by the client in order the recovery operation to continue.
Dismiss an user prompt waiting for a client acknowledgment during a recovery operation.
When dismissed the recovery operation will continue.
Get information about recovery steps in a given recovery view mode.
Will fail if unable to retrieve recovery steps in the desired mode in the current recovery plan state.
Add a callout/prompt to the list of recovery steps in a given recovery view mode.
Will fail if cannot retrieve recovery steps in the desired mode in the current recovery plan state.
Get information about a recovery step in a given recovery view mode.
Will fail if can not retrieve recovery steps in the desired mode in the current recovery plan state.
Delete a recovery step in a given recovery view mode.
This operation is possible only for custom-created prompts or callouts.
Get detailed information about a callout/prompt for a recovery step in a given recovery view mode.
Will fail if cannot retrieve recovery steps in the desired mode in the current recovery plan state or the recovery step is not callout/prompt-related.
Modify a callout/prompt to the list of recovery steps in a given recovery view mode.
Will fail if cannot retrieve recovery steps in the desired mode in the current recovery plan state or the recovery step is not callout/prompt-related.
Get the test networks configured for a recovery plan in a given pairing.
Get virtual machines that are part of a recovery plan in a given pairing.
Get the protected virtual machine included in a recovery plan in a given pairing.
Get recovery settings for a protected virtual machine.
Update recovery settings for a protected virtual machine.
Get the dependent VMs for a protected virtual machine.
Update the dependent VMs of a protected virtual machine.
Checks if a given list of dependent VMs is valid against the current VM.
Get the IP customization for a protected virtual machine.
Update the IP customization for a protected virtual machine.
Get the protected virtual machine priority during a recovery.
Update the recovery priority of a protected virtual machine.
Get a summary of the recovery settings for a protected virtual machine.
Get information about all Site Recovery Manager array managers that are part of a given pairing.
Create a Site Recovery Manager array manager that is part of a given pairing.
Get information about a Site Recovery Manager array manager that is part of a given pairing.
Delete a Site Recovery Manager array manager that is part of a given pairing.
Discovers storage arrays configured for replication by executing SRA command discoverArrays. IDs of discovered array must be unique across all array managers that use the same SRA.
Get information about all Site Recovery Manager replicated array pairs that are part of a given pairing.
Create a Site Recovery Manager replicated array pair that is part of a given pairing.
After the creation of replicated array pair perform discover replicated array pair devices operation.
Get information about a Site Recovery Manager replicated array pair that is part of a given pairing.
Delete a Site Recovery Manager replicated array pair that is part of a given pairing.
Discover storage devices and consistency groups of a Site Recovery Manager replicated array pair by calling command on a storage replication adapter. Perform discoveries and match source and target devices on both sites.
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.
Get information about all storage devices of a Site Recovery Manager replicated array pair that is part of a given pairing.
Get information about all storage replication adapters of a Site Recovery Manager that is part of a given pairing.
Get information about a storage replication adapter of a Site Recovery Manager that is part of a given pairing.
Get connection parameters for a storage replication adapter of a Site Recovery Manager that is part of a given pairing.
Get all vSAN Snapshot Manager protection groups with remote replication matching SRM pair direction.Once vSAN Snapshot Manager protection group is added to an SRM protection group it becomes a managed by SRM andany standalone recovery operations outside SRM control are disabled.
Get information about a vSAN Snapshot Manager protection group with remote replication matching SRM pair direction.Once vSAN Snapshot Manager protection group is added to an SRM protection group it becomes a managed by SRM andany standalone recovery operations outside SRM control are disabled.
Get information about all VMware vSphere Virtual Volumes (vVols) fault domains that are part of a given pairing.
Get details about a VMware vSphere Virtual Volumes (vVols) fault domain that is part of a given pairing.
Get information about all replication groups that are part of a VMware vSphere Virtual Volumes fault domain.
Get information about a replication group that is part of a VMware Virtual Volumes fault domain.
Export the configuration on demand.
Triggers upload operation on demand. The uploaded export files are generated since last upload operation. If there is no upload operation yet, upload all existed export files. If there are no export files to be uploaded, nothing happens.
Get all export files information available on the appliance.
Delete the selected export files.
Retrieves the export file using the Binary datatype.
Get current active export settings.
Set the export settings. The export settings include enableScheduler, retention, scheduleSpec, and so on. If the 'enableScheduler' is set 'True' and 'ScheduleSpec' was set before or is set in the same time, a cron job which exports config on schedule will be created. If the 'enableScheduler' is not set, 'ScheduleSpec' is set and "enableScheduler" is enabled before, the cron job is also created. If the 'enableScheduler' is set to 'False', the existed cron job will be deleted.
Information about the current Site Recovery Manager server.
Retrieve all the recent tasks.
Retrieve the task information.
Get a list of all vCenter Server instances in the pairing.
Get information about a vCenter Server that is part of a given pairing.
Get information about the vCenter Server's compute inventory.
Get information about the vCenter Server's compute object.
Browse files and folders accessible to vCenter server's compute object.
Get information about the vCenter Server's datastores.
Get information about the vCenter Server's datastore object.
Get information about the vCenter Server's network inventory.
Get information about the vCenter Server's network object.
Returns a list of children of a given folder by path.
Get information about the vCenter Server's VM folder object.
Replicated VMs that are not protected by Site Recovery Manager can be used to create a protection group.
Retrieve the vCenter Server's storage policies.
Get information about the vCenter Server's storage policy object.