VMs API XML Response Format

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 is an example response XML body for

https://zvm_ip:port/v1/vms and, without the array statement, for

https://zvm_ip:port/v1/vms/{vmId}.

<ArrayOfVmApi xmlns="http://schemas.zerto.com/zvm/api">
  <VmApi>
    <ActualRPO>2147483647</ActualRPO>
    <Entities>
      <Protected>VCVpg</Protected>
      <Recovery>VCVpg</Recovery>
      <Source>VCVpg</Source>
      <Target>VCVpg</Target>
    </Entities>
    <IOPS>2147483647</IOPS>
    <LastTest>2021-06-15T04:31:21.651Z</LastTest>
    <Link>
      <href>String content</href>
      <identifier>String content</identifier>
      <rel>String content</rel>
      <type>String content</type>
    </Link>
    <Link__x007B_0_x007D_>
      <href>String content</href>
      <rel>String content</rel>
      <type>String content</type>
    </Link__x007B_0_x007D_>
    <OrganizationName>String content</OrganizationName>
    <Priority>Low</Priority>
    <ProtectedSite_>
      <href>String content</href>
      <identifier>String content</identifier>
      <rel>String content</rel>
      <type>String content</type>
    </ProtectedSite>
    <ProvisionedStorageInMB>2147483647</ProvisionedStorageInMB>
    <RecoverySite_>
      <href>String content</href>
      <identifier>String content</identifier>
      <rel>String content</rel>
      <type>String content</type>
    </RecoverySite>
    <SourceSite>String content</SourceSite>
    <Status>Initializing</Status>
    <SubStatus>None</SubStatus>
    <TargetSite>String content</TargetSite>
    <ThroughputInMB>1.26743233E+15</ThroughputInMB>
    <UsedStorageInMB>2147483647</UsedStorageInMB>
    <VmIdentifier>String content</VmIdentifier>
    <VmName>String content</VmName>
    <Volumes_>
      <VmVolumeApi>
        VmVolumeIdentifier>
      </VmVolumeApi>
    </Volumes>
    <VpgName>String content</VpgName>
    <EnabledActions>
      <IsFlrEnabled>False</IsFlrEnabled>
    </EnabledActions>
    <VpgIdentifier>String content</VpgIdentifier>
  </VmApi>
...
</ArrayOfVmApi>