Virtualization Sites 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.

Virtualization sites

The following is an example response XML body for

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

https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}.

<ArrayOfVirtualizationSiteApi xmlns="http://schemas.zerto.com/zvm/api">
  <VirtualizationSiteApi>
    <SiteIdentifier>String content</SiteIdentifier>
    <VirtualizationSiteName>String content</VirtualizationSiteName>
  </VirtualizationSiteApi>
...
</ArrayOfVirtualizationSiteApi>

Datastore clusters

The following is an example response XML body for

https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/datastoreclusters.

<ArrayOfDatastoreClusterNativeApi xmlns="http://schemas.zerto.com/zvm/api">
  <DatastoreClusterNativeApi>
    <DatastoreClusterName>String content</DatastoreClusterName>
  </DatastoreClusterNativeApi>
...
</ArrayOfDatastoreClusterNativeApi>

Datastores

The following is an example response XML body for

https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/datastores.

<ArrayOfDatastoreNativeApi xmlns="http://schemas.zerto.com/zvm/api">
  <DatastoreNativeApi>
    <DatastoreIdentifier>String content</DatastoreIdentifier>
    <DatastoreName>String content</DatastoreName>
  </DatastoreNativeApi>
...
</ArrayOfDatastoreNativeApi>

Folders

The following is an example response XML body for

https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/folders.

<ArrayOfFolderNativeApi xmlns="http://schemas.zerto.com/zvm/api">
  <FolderNativeApi>
    <FolderIdentifier>String content</FolderIdentifier>
    <FolderName>String content</FolderName>
  </FolderNativeApi>
...
</ArrayOfFolderNativeApi>

Host clusters

The following is an example response XML body for

https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/hostclusters.

<ArrayOfHostClusterNativeApi xmlns="http://schemas.zerto.com/zvm/api">
  <HostClusterNativeApi>
    <ClusterIdentifier>String content</ClusterIdentifier>
    <VirtualizationClusterName>String content</VirtualizationClusterName>
  </HostClusterNativeApi>
...
</ArrayOfHostClusterNativeApi>

Hosts

The following is an example response XML body for

https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/hosts and, without the array statement, for https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/hosts/{hostIdentifier}.

<ArrayOfHostNativeApi xmlns="http://schemas.zerto.com/zvm/api">
  <HostNativeApi>
    <HostIdentifier>String content</HostIdentifier>
    <VirtualizationHostName>String content</VirtualizationHostName>
  </HostNativeApi>
...
</ArrayOfHostNativeApi>

Networks

The following is an example response XML body for

https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/networks.

<ArrayOfNetworkNativeApi xmlns="http://schemas.zerto.com/zvm/api">
  <NetworkNativeApi>
    <NetworkIdentifier>String content</NetworkIdentifier>
    <VirtualizationNetworkName>String content</VirtualizationNetworkName>
  </NetworkNativeApi>
...
</ArrayOfNetworkNativeApi>

VMware only – Org vDCs

The following is an example response XML body for

https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/orgvdcs.

<ArrayOfOrgVdcNativeApi xmlns="http://schemas.zerto.com/zvm/api">
  <OrgVdcNativeApi>
    <Identifier>String content</Identifier>
    <OrgVdcName>String content</OrgVdcName>
  </OrgVdcNativeApi>
...
</ArrayOfOrgVdcNativeApi>

VMware only – Resource Pools

The following is an example response XML body for

https://zvm_ip:port/v1/virtualizationsites/{siteIdentifier}/resourcepools.

<ArrayOfResourcePoolNativeApi xmlns="http://schemas.zerto.com/zvm/api">
  <ResourcePoolNativeApi>
    <ResourcePoolIdentifier>String content</ResourcePoolIdentifier>
    <ResourcepoolName>String content</ResourcepoolName>
  </ResourcePoolNativeApi>
...
</ArrayOfResourcePoolNativeApi>