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 information about vSphere Replication servers that are paired.
Get information about a specific VR in a pairing
Get all registered replication servers for a VR in a pairing
Register a replication server for a VR 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 VR in a pairing
Update the connection information for this VR server and reset any current connection for a VR 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.
Pause the replication for a virtual machine from the source site to a remote vCenter Server site.
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.
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.
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.
Retrieve information about the disks of a replicated VM
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 VR capability information about a given VM
Retrieve information about the disks of a VM
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 VR server and reset any current connection.
Retrieve all recent tasks
Retrieve task information