Using the Site
Recovery Manager REST API Gateway
Site
Recovery Manager
REST API GatewayVMware
Site Recovery Manager
REST API
Gateway provides an API access to the Site
Recovery Manager
functionality and allows you to programmatically perform various
Site
Recovery Manager
tasks without the use
of the Site
Recovery
user
interface.System Requirements to use the
Site
Recovery Manager REST API
Gateway
Site
Recovery Manager
REST API
GatewayTo use the public REST APIs you must have
an installation of
Site Recovery Manager
8.8 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.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.
Site
Recovery Manager REST API Gateway Documentation
Site
Recovery Manager
REST API Gateway DocumentationThe
Site
Recovery Manager
REST APIs introduce end-to-end automation for
Site
Recovery Manager
.- 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 differentvCenter ServerandSite Recovery Managerobjects.
- 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 manageVMware Site Recovery Managerappliance. See Using the Site Recovery Manager Configuration REST APIs Gateway.
To access the
Site
Recovery Manager
REST API Gateway
documentation and guidelines, see https://developer.broadcom.com/xapis/vmware-site-recovery-manager-rest-api-gateway/latest/.