Zerto Virtual Replication APIs : VPGs API
  
VPGs API
/v1/vpgs returns information about VPGs or creates or performs actions on a specific VPG. The following API are available:
https://zvm_ip:port/v1/vpgs – GET Methods
https://zvm_ip:port/v1/vpgs – POST Methods
https://zvm_ip:port/v1/vpgs – DELETE Methods
Purpose
Method
URI
Information for all VPGs
GET
https://zvm_ip:port/v1/vpgs
Information for one VPG
GET
https://zvm_ip:port/v1/vpgs/{protectionGroupIdentifier}
Checkpoints for a VPG
GET
https://zvm_ip:port/v1/vpgs/{protectionGroupIdentifier}/checkpoints
Valid values for VPG entities
GET
https://zvm_ip:port/v1/vpgs/entitytypes
Valid values for failover commit policies
GET
https://zvm_ip:port/v1/vpgs/failovercommitpolicies
Valid values for failover shutdown policies
GET
https://zvm_ip:port/v1/vpgs/failovershutdownpolicies
Valid values for VPG priorities
GET
https://zvm_ip:port/v1/vpgs/priorities
Valid values for failover retention policies
GET
https://zvm_ip:port/v1/vpgs/retentionpolicies
Valid values for VPG statuses
GET
https://zvm_ip:port/v1/vpgs/statuses
Valid values for VPG substatuses
GET
https://zvm_ip:port/v1/vpgs/substatuses
Create a VPG
POST
https://zvm_ip:port/v1/vpgs
Clone a VPG
POST
https://zvm_ip:port/v1/vpgs/{protectionGroupIdentifier}/CloneStart
Abort a VPG clone
POST
https://zvm_ip:port/v1/vpgs/{protectionGroupIdentifier}/CloneAbort
Failover a VPG
POST
https://zvm_ip:port/v1/vpgs/{protectionGroupIdentifier}/Failover
Commit a VPG failover
POST
https://zvm_ip:port/v1/vpgs/{protectionGroupIdentifier}/FailoverCommit
Rollback a VPG failover
POST
https://zvm_ip:port/v1/vpgs/{protectionGroupIdentifier}/FailoverRollback
Test a VPG
POST
https://zvm_ip:port/v1/vpgs/{protectionGroupIdentifier}/FailoverTest
Stop a VPG test
POST
https://zvm_ip:port/v1/vpgs/{protectionGroupIdentifier}/FailoverTestStop
Force synchronize a VPG
POST
https://zvm_ip:port/v1/vpgs/{protectionGroupIdentifier}/forcesync
Pause VPG protection
POST
https://zvm_ip:port/v1/vpgs/{protectionGroupIdentifier}/pause
Resume VPG protection
POST
https://zvm_ip:port/v1/vpgs/{protectionGroupIdentifier}/resume
Delete a VPG
DELETE
https://zvm_ip:port/v1/vpgs/{VpgIdentifier}
HTTP Methods
GET, POST, DELETE
Security
The API is exposed over HTTPS. Client code must use the x-zerto-session HTTP authorization header.
See Also
Starting a session: https://zvm_ip:port/v1/session – POST Method
View the results of the create VPG operation – Events API
Return the datastore identifier – Datastores
Return the resource pool identifier – Resource Pools (vSphere only)
Return the source and target site identifiers – Virtualization sites
Return the vCenter vApp identifier to protect – vCenter Server vApps (vSphere only)
Return the vCloud Director vApp identifier to protect – vCD vApps (vSphere only)
Return the list of unprotected virtual machine identifiers – Unprotected VMs
Retrieve details of the task being performed – Tasks API
Manage a VPG – VPG Management API (vSphere and Hyper-V only)
Format
Json, XML