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.

The following topics are described in this section:

■ Using the APIs

■ A First Time Tutorial

■ 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.

■ Return a list of available Zerto Virtual Replication v1 REST APIs. See Listing the Available APIs and /v1/ API.

■ Return information about Zerto Virtual Replication alerts. See Alerts API.

■ Dismiss or undismiss an alert. See Alerts API.

■ Return information about Zerto Virtual Replication 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.

■ Return information about service profiles. See Service Profiles 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 protected virtual machines. See VMs that are Protected 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.

■ Manage VPGs. See VPG Management API (vSphere and Hyper-V only).

■ 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 Resources Report API.

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