VMware vSphere Replication REST API Gateway Operations Index
All available VMware vSphere Replication 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 returned session ID value.
Logs out if the session is authenticated.
Get a list of all existing pairings.
Pair to the remote vSphere Replication Management Server.
Get information about the pairing.
Delete the existing pairing with the remote vSphere Replication Management server.
Reconnect the existing pairing to the remote vSphere Replication Management Server (VRMS).
Get all issues for the pairing.
Returns information about the current session to the remote vSphere Replication Management server, if any.
Returns information about the current session to the remote vSphere Replication Management server.
Get replication capabilities of a given pairing. Optionally could pass virtual machine ID to get VM replication capabilities.
Get information about vSphere Replication servers that are paired.
Get information about a specific vSphere Replication Management Server in a pairing.
Get all registered replication servers for a vSphere Replication in a pairing.
Register a replication server for a vSphere Replication in a pairing.
Get information about a registered vSphere Replication server for a VRMS, which is part of a pairing.
Unregister a vSphere Replication server for a vSphere Replication in a pairing.
Update the connection information for this vSphere Replication server and reset any current connection for a vSphere Replication in a pairing.
Get a list of all the incoming or outgoing replications from a vCenter Server.
Use this workflow to configure a replication.
1. Search for VMs that are suitable for a replication.
GET /{pairing_id}/vcenters/{vcenter_id}/vms- Query parameter suitable_for_replication should be true
2. Choose VMs.
3. For each VM, get disks:
GET /{pairing_id}/vcenters/{vcenter_id}/vms/{vm_id}/disks4. Optionally, for each VM, check capabilities if replication is supported and what are the supported replication settings:
GET /{pairing_id}/vcenters/{vcenter_id}/vms/{vm_id}/capability5. Request storage policies at the target vCenter Server:
GET /{pairing_id}/vcenters/{vcenter_id}/storage-policies6. Choose a storage policy. If default storage policy will be used, then set destination_storage_policy_id in the resulting ConfigureReplicationSpec to null.
7. Search for possible target datastores at the target vCenter Server:
GET /{pairing_id}/vcenters/{vcenter_id}/datastores8. Choose a target datastore.
9. Optionally check the selected target datastore's compliance against the selected target storage policy.
POST /{pairing_id}/vcenters/{vcenter_id}/storage-policies/{storage_policy_id}/actions/check-compliance- Pass the chosen datastore IDs as a body to the endpoint
10. Optionally search for seeds at the target vCenter Server for the chosen target datastore from step 8:
a.
POST /{pairing_id}/vcenters/{vcenter_id}/datastores/{datastore_id}/actions/find-seeds- Pass spec based on the VM disks retrieved in step 3
b. Or browse the datastore to select manually seed folder/file
POST /{pairing_id}/vcenters/{vcenter_id}/datastores/{datastore_id}/actions/browse- Pass spec for specific type and path of files/folders
11. Construct ConfigureReplicationSpec.
12. Create a replication.
POST /{pairing_id}/replications
Get the total number of replications - both incoming and outgoing.
Get a list of all the current issues for all incoming or outgoing replications.
Get information about the replication.
Delete replication of a VM. The operation deletes the replication only on the local site. Remove the replication configuration first.
Run a cleanup test recovery for a given replication. This includes removing or reloading the placeholder VM from original path and reverting the test bubble image. Operation is available only on recovery site (for incoming replications).
Remove the promotion of the latest promoted test image associated with this group (if any) as an established promoted instance. The promoted instance is "demoted" to a regular group instance and becomes a candidate for pruning. Operation is available only on recovery site (for incoming replications)
Pause the replication for a virtual machine from the source site to a remote vCenter Server site.
Cleanup files and objects associated with the image of a group while retaining the contents of the image as a new instance. Only one image of any type can exist for a group at any given moment. The image must be a test bubble image, attempting to promote a failover image will fail. Operation is available only on recovery site (for incoming replications).
Change the settings of a replication, including reconfiguring a replication on new virtual hard disks and enabling the default seed disk to use a replica disk in the VM folder.
Run a disaster recovery for a given replication. Operation is available only on recovery site (for incoming replications). The operation requires a valid VMware Live Recovery subscription.
Resume a paused replication to the target vCenter Server site.
Sync the latest changes for a virtual machine with a configured replication to the target vCenter Server site.
Run a test recovery for a given replication. A VM is created and registered at the recovery site. You can use the VM to run tests, security scans and ransomware-cleanup. Operation is available only on recovery site (for incoming replications). The operation requires a valid VMware Live Recovery subscription.
Gracefully remove the replication configuration of a VM. If the remote site is not available, use DELETE /replications/{replication_id} to delete the replication from the local site.
There are two types of images: test-bubble and failover. A test-bubble image is expected to be reverted after any testing is completed. Optionally, it is possible to promote the image to a recovery image. A failover image will either be reverted or committed. Will return 404 Not Found in case there is no active replication image. Operation is available only on recovery site (for incoming replications).
Retrieve information about the disks of a replicated VM.
Get a list of all available consistent replicas (point in time instances) for a given replication.
Get a specific consistent replica (point in time instance) for a given replication.
Retrieve vSphere Replication supported datastores.
Browse the datastore that is defined in the URL by its ID. This API returns files that reside on the given datastore. These files are filtered based on the given search criteria.
Retrieve information about possible seeds for a given set of disks.
Retrieve vCenter Server's storage policies.
Check datastores for compliance against a given storage policy.
Get a list of all VMs on the vCenter Server specified by vCenter Server ID in the URL.
Retrieve vSphere Replication capability information about a given VM.
Retrieve information about the disks of a VM.
Get information about all replication mappings in a pairing.
Add replication mappings for a vSphere Replication Management Server in a given pairing.
Calculate replication mappings for a vSphere Replication Management Server by a given set of datastores as source and a set of datastores/datastore clusters as a target. The result will contain a list of mappings between all compute clusters where the source and target datastores/datastore clusters are accessible from.
Run tests for all replication mappings for a vSphere Replication Management Server in a given pairing.
Get information about a specific replication mapping in a pairing.
Delete a configured replication mapping for a vSphere Replication Management Server in a given pairing.
Get test results about a specific replication mapping in a pairing.
Lists details about the vSphere Replication Management Server.
Get all registered replication servers.
Register a replication server.
Get information about a registered vSphere Replication server.
Unregister a vSphere Replication server.
Update the connection information of this vSphere Replication server and reset any current connection.
Retrieve all recent tasks.
Retrieve task information.
Get information about the vCenter Server's compute inventory.
Get information about the vCenter Server's compute object.
Retrieve datastores accessible by a given vCenter Server's compute resource.
Returns a list of children of a given folder by path.
Get information about the vCenter Server's VM folder object.