Introduction to the Zerto Restful APIs
The Zerto RESTful API enables you to manage Zerto programmatically. The REST APIs provide a way to automate many of the tasks required to manage DR, without having to use the Zerto User Interface. For related documentation, refer to myZerto > Technical Documentation.
The following topics are described in this section:
APIs are available both to return status information and to perform actions, such as a failover. The REST APIs are used for the following:
|
•
|
Start and end a session. See below, and Session API . |
|
•
|
Return a list of available Zerto v1 REST APIs. See and /v1/ API. |
|
•
|
Return information about Zerto alerts. See Alerts API. |
|
•
|
Return information about Zerto events. See Events API. |
|
•
|
Return information about the local site where the API is run. See Local Site API |
|
•
|
Return information about the peer sites for the site where the API is run. See Peer Sites API. |
|
•
|
Perform unpairing the current site to a peer site. See Peer Sites API |
|
•
|
Return information about tasks run at a site. See Tasks API. |
|
•
|
Return information about the hypervisor site where the API is run and the paired hypervisor sites and as well as information about the resources at a specified site. See Virtualization Sites API. |
|
•
|
Return information about VPGs. See VPGs API |
|
•
|
Perform actions on a VPG, such as creating, failing over, cloning, testing, or deleting a VPG. See VPGs API |
|
•
|
Return information about VRAs. See VRAs API |
|
•
|
Perform actions on a VRA, such as installing, editing, or deleting a VRA. See VRAs API |
|
•
|
Return information about ZORGS. Described in ZORGs API |
|
•
|
Generate a resource report about the virtual machines being protected to a recovery site. See Managing vCD APIs |
The information returned by these APIs refers to what is managed by the Zerto Virtual Manager where the API is run.