[{"label":"Latest (1.0.0)","version":"latest"}]
vsphere-replication-api

VMware vSphere Replication REST API Gateway Operations Index

All available VMware vSphere Replication 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 returned session ID value.
delete Logout
Logs out if the session is authenticated

Pairing

post Create Remote Session
Returns information about the current session to the remote vSphere Replication Management server
delete Delete VR Pairing
Delete the existing pairing with the remote vSphere Replication Management server.
get Get All VR Details In Pairing
Get information about vSphere Replication servers that are paired.
get Get All VR Servers In Pairing
Get all registered replication servers for a VR in a pairing
get Get Remote Session
Returns information about the current session to the remote vSphere Replication Management server, if any.
get Get VR Info In Pairing
Get information about a specific VR in a pairing
get Get VR Pairing
Get information about the pairing
get Get VR Pairing Issues
Get all issues for the pairing
get Get VR Pairings
Get a list of all existing pairings.
get Get VR Server In Pairing
Get information about a registered vSphere Replication server for a VRMS, which is part of a pairing
post Pair VR
Pair to the remote vSphere Replication Management Server.
post Reconnect VR Pairing
Reconnect the existing pairing to the remote vSphere Replication Management Server (VRMS)
post Reconnect VR Server In Pairing
Update the connection information for this VR server and reset any current connection for a VR in a pairing
post Register VR Server In Pairing
Register a replication server for a VR in a pairing
delete Unregister VR Server In Pairing
Unregister a vSphere Replication server for a VR in a pairing

Replication

post Browse Datastore
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.
post Check Storage Policy Compliance
Check datastores for compliance against a given storage policy.
post Configure Replication
Configure replication for a virtual machine from a source site to a target vCenter Server site.
delete Destroy Replication
Delete replication of a VM. The operation deletes the replication only on the local site. Remove the replication configuration first.
get Get All Replications
Get a list of all the incoming or outgoing replications from a vCenter Server.
get Get Local VM Disks
Retrieve information about the disks of a VM
get Get Local VMS
Get a list of all VMs on the vCenter Server specified by vCenter Server ID in the URL.
get Get Replicated VM Disks
Retrieve information about the disks of a replicated VM
get Get Replication Info
Get information about the replication
get Get Replications Count
Get the total number of replications - both incoming and outgoing.
get Get Replications Issues
Get a list of all the current issues for all incoming or outgoing replications.
post Get Seeds For Disks
Retrieve information about possible seeds for a given set of disks
get Get VC Storage Policies
Retrieve vCenter Server's storage policies
get Get VM Capability
Retrieve VR capability information about a given VM
get Get VR Capable Target Datastores
Retrieve vSphere Replication supported datastores
post Pause Replication
Pause the replication for a virtual machine from the source site to a remote vCenter Server site.
post Reconfigure Replication
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.
post Resume Replication
Resume a paused replication to the target vCenter Server site.
post Sync Replication
Sync the latest changes for a virtual machine with a configured replication to the target vCenter Server site.
post Unconfigure Replication
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.

Server

get Get All VR Servers
Get all registered replication servers.
get Get VR Info
vSphere Replication Management Server information
get Get VR Server
Get information about a registered vSphere Replication server.
post Reconnect VR Server
Update the connection information of this VR server and reset any current connection.
post Register VR Server
Register a replication server.
delete Unregister VR Server
Unregister a vSphere Replication server.

Tasks

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

Feedback

Was this page helpful?