Introduction to the Zerto Virtual Replication Restful APIs

The Zerto Virtual Replication RESTful API enables you to manage Zerto Virtual Replication 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:

■	Using the APIs

■	Managing VPGs

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, Using the APIs and “Session API”, on page 103.

■	Return a list of available Zerto Virtual Replication v1 REST APIs. See Listing the Available APIs and “/v1/ API”, on page 29.

■	Return information about Zerto Virtual Replication alerts. See “Alerts API”, on page 30.

■	Dismiss or undismiss an alert. See “Alerts API”, on page 30.

■	Return information about Zerto Virtual Replication events. See “Events API”, on page 54.

■	Return information about the local site where the API is run. See “Local Site API”, on page 78.

■	Return information about the peer sites for the site where the API is run. See “Peer Sites API”, on page 80.

■	Perform pairing the current site to a peer site. See “Peer Sites API”, on page 80

■	Perform unpairing the current site to a peer site. See “Peer Sites API”, on page 80

■	Return information about service profiles. See “Service Profiles API”, on page 101.

■	Return information about tasks run at a site. See “Tasks API”, on page 106.

■	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”, on page 116.

■	Return information about protected virtual machines. See “Protected VMs API”, on page 124.

■	Return information about VPGs. See “VPGs API”, on page 137.

■	Perform actions on a VPG, such as creating, failing over, cloning, testing, or deleting a VPG. See “VPGs API”, on page 137.

■	Manage VPGs. See “VPG Management API”, on page 160.

■	Return information about VRAs. See “VRAs API”, on page 230.

■	Perform actions on a VRA, such as installing, editing, or deleting a VRA. See “VRAs API”, on page 230.

■	Return information about ZORGS. Described in “ZORGs API”, on page 243.

■	Generate a resource report about the virtual machines being protected to a recovery site. See “Managing vCD APIs”, on page 248.

The information returned by these APIs refers to what is managed by the Zerto Virtual Manager where the API is run.