VMware vSphere Replication REST API Gateway provides an API access to the vSphere Replication functionality and allows you to programmatically perform various vSphere Replication tasks without the use of the Site Recovery user interface.

System Requirements to use the vSphere Replication REST API Gateway

To use the public REST APIs, you must have an installation of vSphere Replication 8.6 or later.

Before you run any REST APIs to or from a target site, verify that you have created a session to the desired vCenter Server site by using the vSphere Replication REST API Gateway.

Note: In a federated environment with linked vCenter Server instances, when you log in to the REST API gateway local site this will automatically log you in to the remote site. You do not have to make a POST /remote-session request. It is not possible to log in to the remote site with a different user name.

vSphere Replication REST API Gateway Documentation

The vSphere Replication REST APIs introduce an end-to-end automation for vSphere Replication:
  • Configure and reconfigure a replication.
  • REST APIs for monitoring replications, pairings, and statuses.
  • Ability to manage vSphere Replication - Start/Stop/Pause/Resume/Delete, with the option to retain replica disks.
  • Full set of REST APIs to configure and manage the vSphere Replication appliance.
You can access the vSphere Replication REST APIs documentation and guidelines at https://developer.broadcom.com/xapis/.