Zerto APIs : Protected VMs API : URL
  
URL
All VMs
https://zvm_ip:port/v1/vms
Filtered VMs
https://zvm_ip:port/v1/vms?vpgName={VPGNAME}&vmName={VMNAME}&status={STATUS}&substatus={SUBSTATUS}&organizationName={ORGNAME}&priority={PRIORITY}&protectedSiteType={PROTECTEDSITETYPE}&recoverySiteType={RECOVERYSITETYPE}&protectedSiteIdentifier={PROTECTEDSITEIDENTIFIER}&recoverySiteIdentifier={RECOVERYSITEIDENTIFIER}vmIdentifier={vmIdentifier}
Single VM
https://zvm_ip:port/v1/vms/{vmIdentifier}
Note: Running an API for a single virtual machine returns details of the single virtual machine only if it is protected in a single VPG. For information about virtual machines that are protected in several VPGs, use the filter vmIdentifier.
Where:
zvm_ip
The IP address of the Zerto Virtual Manager where the API is run.
port
The port to access the Zerto Virtual Manager. The default port is 9669.
vmIdentifier
The identifier of the virtual machine for which information is returned.
The identifier comprises the server identifier and the virtual machine moref, with the format, serverid.moref.
Filters
Filters are optional and any combination of filters is valid. When no filter is specified, all virtual machines are returned. Filters are not case-sensitive.
 
Filter
Description
 
vpgName
The name of the VPG which protects the virtual machine.
 
vmName
The name of the virtual machine.
 
status
The status of the VPG. Possible values are:
0 or Initializing– The VPG is being initialized. This includes when a VPG is created, and during the initial sync between sites.
1 or MeetingSLA: The VPG is meeting the SLA specification.
2 or NotMeetingSLA: The VPG is not meeting the SLA specification for both the journal history and RPO SLA settings.
3 or RpoNotMeetingSLA: The VPG is not meeting the SLA specification for the RPO SLA setting.
4 or HistoryNotMeetingSLA: The VPG is not meeting the SLA specification for the journal history.
5 or FailingOver: The VPG is in a Failover operation.
6 or Moving: The VPG is in a Move operation.
7 or Deleting: The VPG is being deleted.
8 or Recovered: The VPG has been recovered.
 
substatus
The substatus of the VPG, for example the VPG is in a bitmap sync. For the description of substatuses, refer to the Zerto Virtual Manager Administration Guide. Possible values are:
0 or None
1 or InitialSync
2 or Creating
3 or VolumeInitialSync
4 or Sync
5 or RecoveryPossible
6 or DeltaSync
7 or NeedsConfiguration
8 or Error
9 or EmptyProtectionGroup
 
 
10 or DisconnectedFromPeerNoRecoveryPoints
11 or FullSync
12 or VolumeDeltaSync
13 or VolumeFullSync
14 or FailingOverCommitting
15 or FailingOverBeforeCommit
16 or FailingOverRollingBack
17 or Promoting
18 or MovingCommitting
19 or MovingBeforeCommit
 
 
20 or MovingRollingBack
21 or Deleting
22 or PendingRemove
23 or BitmapSync
24 or DisconnectedFromPeer
25 or ReplicationPausedUserInitiated
26 or ReplicationPausedSystemInitiated
27 or RecoveryStorageProfileError
29 or RollingBack
 
30 or RecoveryStorageError
31 or JournalStorageError
32 or VmNotProtectedError
33 or JournalOrRecoveryMissingError
34 or AddedVmsInInitialSync
35 or ReplicationPausedForMissingVolume
 
sourceType
Deprecated. See protectedSiteType.
 
targetType
Deprecated. See recoverySiteType.
 
sourceSite
Deprecated. See protectedSiteIdentifier.
 
targetSite
Deprecated. See recoverySiteIdentifier.
 
protectedSiteType
The protected site environment. Possible values are:
0 or VCVpg: The VPG is protecting virtual machines in a VMware vCenter Server.
1 or VCvApp: Deprecated. See VCDvApp.
2 or VCDvApp: The VPG is protecting a VMware vCloud Director vApp.
3 or PublicCloud– Not applicable.
4 or HyperV: The VPG is protecting virtual machines in Microsoft Hyper-V.
 
recoverySiteType
The recovery site environment. Possible values are:
0 or VCVpg: The VPG is recovering virtual machines in a VMware vCenter Server.
1 or VCvApp: Deprecated. See VCDvApp.
2 or VCDvApp: The VPG is recovering a VMware vCloud Director vApp.
3 or PublicCloud: The VPG is recovering virtual machines to a public cloud.
4 or HyperV: The VPG is recovering virtual machines in Microsoft Hyper-V.
 
protectedSiteIdentifier
The identifier of the protected site where the VPG virtual machines are protected.
 
recoverySiteIdentifier
The identifier of the recovery site where the VPG virtual machines are recovered.
 
organizationName
The ZORG for this VPG.
 
priority
The priority specified for the VPG. Possible values are:
0 or Low: The VPG has a low priority for transferring data.
1 or Medium: The VPG has a medium priority for transferring data.
2 or High: The VPG has a high priority for transferring data.