Zerto Virtual Replication APIs : VPG Management API (vSphere and Hyper-V only)
  
VPG Management API (vSphere and Hyper-V only)
Note: The /v1/vpgSettings API does not work in a vCloud Director environment.
/v1/vpgSettings returns information about VPG settings, creates new VPGs, edits VPG settings, or deletes all or selected VPG settings for a VPG. The following API are available:
■ https://zvm_ip:port/v1/vpgSettings – GET Methods
■ https://zvm_ip:port/v1/vpgSettings – POST Methods
■ https://zvm_ip:port/v1/vpgSettings – PUT Methods
■ https://zvm_ip:port/v1/vpgSettings – DELETE Methods
Purpose
Method
URI
Get settings for VPGs
GET
https://zvm_ip:port/v1/vpgSettings
Get settings for a VPG
GET
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}
Get VPG backup settings
GET
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/backup
Get the day a backup is scheduled
GET
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/backup/dayofweek
Get a VPG backup retention period
GET
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/backup/retentionperiod
Get a VPG backup schedule
GET
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/backup/schedulerperiod
Get VPG basic settings
GET
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/basic
Get VPG boot settings
GET
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/bootgroup
Get VPG journal settings
GET
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/journal
Get VPG network settings
GET
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/networks
Get VPG network mapping settings – for future use
GET
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/networksmapping
Get the VPG priority
GET
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/priority
Get VPG recovery settings
GET
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/recovery
Get VPG script settings
GET
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/scripting
Get all VM settings for a VPG
GET
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms
Get VM settings for a VM in a VPG
GET
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}
Get all VM NIC settings
GET
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/nics
Get settings for a VM NIC
GET
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/nics/{nicIdentifier}
Get VM volume settings
GET
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/volumes
Get settings for a VM volume
GET
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/volumes/{volumeId}
Create new VPG settings object
POST
https://zvm_ip:port/v1/vpgSettings
Create VPG settings object for an existing VPG
POST
https://zvm_ip:port/v1/vpgSettings
Commit a settings object
POST
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/commit
Add VMs to a settings object
POST
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms
Add a NIC to a settings object
POST
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/nics
Edit VPG settings object
PUT
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}
Edit backup settings object
PUT
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/backup
Edit basic settings object
PUT
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/basic
Edit boot settings object
PUT
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/bootgroup
Edit journal settings object
PUT
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/journal
Edit network settings object
PUT
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/networks
Edit network mapping settings object – for future use
PUT
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/networksmapping
Edit recovery settings object
PUT
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/recovery
Edit script settings object
PUT
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/scripting
Edit VM settings object
PUT
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}
Edit NIC settings object
PUT
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/nics/{nicIdentifier}
Edit volume settings object
PUT
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/volumes/{volumeId}
Delete a settings object
DELETE
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}
Delete backup settings object
DELETE
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/backup
Delete basic settings object
DELETE
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/basic
Delete boot settings object
DELETE
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/bootgroup
Delete journal settings object
DELETE
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/journal
Delete network settings object
DELETE
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/networks
Delete network mapping settings object – for future use
DELETE
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/networksmapping
Delete recovery settings object
DELETE
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/recovery
Delete script settings object
DELETE
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/scripting
Delete VM settings from a VPG
DELETE
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}
Delete NIC settings object
DELETE
https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/nics/{nicIdentifier}
HTTP Methods
GET, POST, PUT, 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
Perform actions, such as testing, a VPG – VPGs API
Format
Json, XML