All APIs
Important: This document is being phased out and does not contain up-to-date information. For updated API documentation for Zerto versions 9.5 and later, see ZVM REST API - Swagger.
You can also access Swagger from the ZVM: click the menu button (
) on the top right and select APIs or navigate to https://<ZVM IP>:9669/swagger/index.html in a Windows ZVM or https://<ZVM IP>/management/api/swagger/index.html in ZVM Appliance.
The following APIs are available:
| API | Subject of API | Method | Description |
|---|---|---|---|
| /v1/ | List available APIs | GET | Retrieves the list of available Zerto v1 REST APIs. See /v1/ API. |
| /v1/alerts | Alert information | GET | Retrieves information about Zerto alerts. See Alerts API and Alerts: GET. |
| /v1/alerts | Alert actions | POST | Dismisses or undismisses an alert. See Alerts API and Alerts: POST. |
| /v1/datastores | Datastores information | GET | Retrieves information about datastores. See Datastores API. |
| /v1/events | Events | GET | Retrieves information about Zerto events. See Events API. |
| /v1/flrs | File level recovery Information | GET, POST, DELETE | Retrieve information and manage file level recovery. See File Level Recovery. |
| /v1/license | License | GET, POST, DELETE | Retrieve information about licenses and manage licensing. See License API. |
| /v1/localsite | Local site information | GET | Retrieves information about the local site where the API is run. See Local Site API. |
| /v1/peersites | Peer site information | GET | Retrieves information about the peer sites for the site where the API is run. See Peer Sites API and Peersites - GET. |
| /v1/peersites | Peer site action | POST | Adds a peer site. See Peer Sites API and Peersites - POST. |
| /v1/peersites | Peer site action | DELETE | Unpair a peer site. See Peer Sites API and Peersites - POST. |
| /v1/Reports/recovery | Recovery report | GET | Retrieve information about recovery actions. See Recovery Report API. |
| /v1/reports/resources | Run the resource report | GET | Generates resource information for the virtual machines being recovered to the site where the report is run. See storagepolicy. |
| /v1/serviceprofiles | Service profiles | GET | Retrieves service profile information. See Service Profiles API. |
| /v1/session | Session management | POST | Starts a session. See Session API and Session: POST. |
| /v1/session | Session management | DELETE | Ends a session. See Session API and Session: DELETE. |
| /v1/tasks | Task information | GET | Retrieves information about tasks run at a site. See Tasks API. |
| /v1/ virtualizationsites |
Site information | GET | Retrieves information about the hypervisor site where the API is run and the paired hypervisor sites as well as information about the resources at a specified site. See Virtualization Sites API. |
| /v1/vms | Protected virtual machine information | GET | Retrieves information about protected virtual machines. See Protected VMs API. |
| /v1/volumes | Volumes information | GET | Retrieves information about volumes. See Volumes API. |
| /v1/vpgs | VPG information | GET | Retrieves information about VPGs. See VPGs API and VPGs: GET. |
| /v1/vpgs | VPG actions | POST | Performs actions on a VPG. See VPGs API and VPGs: POST. |
| /v1/vpgs | VPG actions | DELETE | Deletes a VPG. See VPGs API and VPGs: DELETE. |
| /v1/vpgSettings | Manage a VPG | GET | Manages a vpgSettings object. See VPG Management API and VPG Settings: GET. |
| /v1/vpgSettings | Manage a VPG | POST | Performs actions on a vpgSettings object. See VPG Management API and VPG Settings: POST. |
| /v1/vpgSettings | Manage a VPG | PUT | Enables editing a vpgSettings object. See VPG Management API and VPG Settings: PUT. |
| /v1/vpgSettings | Manage a VPG | DELETE | Deletes a vpgSettings object. See VPG Management API and VPG Settings: DELETE. |
| /v1/vpgSettings/copyVpgSettings | Manage a VPG | POST, PUT | Enables creating a new vpgSettings object by copying an existing vpgSettings object. See VPG Management API and vSphere and Hyper-V - Copy VPG Settings |
| /v1/vras | VRA information | GET | Retrieves VRA information. See VRAs API and VRAs: GET. |
| /v1/vras | VRA actions | POST | Performs actions on a VRA. See VRAs API and VRAs: POST |
| /v1/vras | VRA actions | PUT | Enables editing a VRA. See VRAs API and VRAs: PUT. |
| /v1/vras | VRA actions | DELETE | Deletes a VRA. See VRAs API and VRAs: DELETE. |
| /v1/vras/changeRecoveryVra | Change recovery host of VMs | GET, POST, PUT | Changes the recovery host for all or some VMs. See VRAs: Change Recovery VRA APIs |
|
/v1/zorgs |
ZORG information |
GET |
Retrieves ZORG information. See in ZORGs API. |
| /v1/zsspSessions | ZSSP Sessions | GET, POST, DELETE | Retrieve information and Manage ZSSP Sessions. See ZSSP Sessions API |
| vCD APIs | Manage vCD VPGs | View, create, update or delete vCD VPGs. See Managing vCD APIs. |
|
| vSphere to vCD APIs | Manage vSphere to vCD VPGs | GET, POST, PUT | See vSphere to vCD VPG Management APIs |
| vSphere to Azure APIs | Manage vSphere to Azure VPGs | GET, POST, PUT | See vSphere to Azure VPG Management APIs |