Using the VMware Live Site Recovery REST API Gateway

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

System Requirements to use the VMware Live Site Recovery REST API Gateway

To use the public REST APIs you must have an installation of Site Recovery Manager 9.0 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 instance.

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.

VMware Live Site Recovery REST API Gateway Documentation

The VMware Live Site Recovery REST APIs introduce end-to-end automation for VMware Live Site Recovery.

• Ability to create, remove, and reconfigure site pairs.
• Ability to create, edit, delete Protection Groups and Recovery Plans.
• Get protection and recovery settings for VMs. Protect and remove protection VM operations.
• Create, modify, remove Inventory mappings and IP customization.
• Reconfigure Recovery settings for VMs - Add, Edit, Delete Callouts and Prompts, Set, Get priority and dependencies.
• Full set of APIs to retrieve information about different vCenter Server and VMware Live Site Recovery objects.
• Operations for working with array managers and array pairs - create, delete, discover devices and so on.
• Recovery plans execution - Test, Planned Migration, Failover, Re-protect, and Failback.
• Full set of APIs to configure and manage VMware Live Site Recovery appliance. See Using the VMware Live Site Recovery Configuration REST APIs Gateway.

To access the VMware Live Site Recovery REST API Gateway documentation and guidelines, see https://developer.broadcom.com/xapis/vmware-site-recovery-manager-rest-api-gateway/latest/.