Datastores 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/datastores.

<ArrayOfDatastoreApi xmlns="http://schemas.zerto.com/zvm/api" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <DatastoreApi>
    <Config>
      <Devices xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a:string>naa.64ed2a2559082bd7f08f25962af9e6c3</a:string>
      </Devices>
      <OwningCluster i:nil="true"/>
      <Type i:nil="true"/>
    </Config>
    <DatastoreIdentifier>stringcontent</DatastoreIdentifier>
    <DatastoreName>Cluster1</DatastoreName>
    <Health i:nil="true"/>
    <Stats>
      <AvailabilityStatus>Normal</AvailabilityStatus>
      <NumIncomingVMs>0</NumIncomingVMs>
      <NumOutgoingVMs>0</NumOutgoingVMs>
      <NumVRAs>0</NumVRAs>
      <Usage>

      </Devices> xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      </Devices>
      <OwningCluster i:nil="true"/>
      <Type>VMFS</Type>
    </Config>
    <DatastoreIdentifier>stringcontent</DatastoreIdentifier>
    <DatastoreName>Cluster1</DatastoreName>
    <Health i:nil="true"/>
    <Stats>
      <AvailabilityStatus>Normal</AvailabilityStatus>
      <NumIncomingVMs>0</NumIncomingVMs>
      <NumOutgoingVMs>0</NumOutgoingVMs>
      <NumVRAs>0</NumVRAs>
      <Usage>

      </Devices>xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">      </Devices>
      <OwningCluster i:nil="true"/>
      <Type>VMFS</Type>
    </Config>
    <DatastoreIdentifier>stringcontent</DatastoreIdentifier>
    <DatastoreName>Cluster1</DatastoreName>
    <Health i:nil="true"/>
    <Stats>
      <AvailabilityStatus>Normal</AvailabilityStatus>
      <NumIncomingVMs>0</NumIncomingVMs>
      <NumOutgoingVMs>0</NumOutgoingVMs>
      <NumVRAs>0</NumVRAs>
      <Usage>

The following is an example response XML body for https://zvm_ip:port/v1/datastores/{datastoreIdentifier}.

    </Devices> xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <a:string>naa.64ed2a2559082bdb9c9895992af926e6</a:string>
     <a:string>naa.64ed2a2559088b6eb8a4659a2af926fa</a:string>
    </Devices>
    <OwningCluster i:nil="true"/>
    <Type>VMFS</Type>
  </Config>
  <DatastoreIdentifier>stringcontent</DatastoreIdentifier>
  <DatastoreName>Cluster1</DatastoreName>
  <Health i:nil="true"/>
  <Stats>
    <AvailabilityStatus>Normal</AvailabilityStatus>
    <NumIncomingVMs>0</NumIncomingVMs>
    <NumOutgoingVMs>0</NumOutgoingVMs>
      <NumVRAs>0</NumVRAs>
      <Usage>

The following is an example response XML body forhttps://zvm_ip:port/v1/volumes?volumeType={volumeType}&vpgIdentifier={vpgIdentifier}&datastoreIdentifier={datastoreIdentifier}&vmIdentifier={vmIdentifier}.

      </Datastore>
        <Identifier>stringcontent</Identifier>
        <Name>stringcontent</Name>
      </Datastore>
      <IsThinProvisioned>true</IsThinProvisioned>
      <OwningVm>
        <Identifier>689ddcc7-21df-48aa-a9db-ba10bec79a47.vm-641</Identifier>
        <Name>Z-VRA-172.20.118.4</Name>
      </OwningVm>
      <Path>
        <FileName>stringcontent</FileName>
        <Full>[BK4BL08_EQL_DS3]stringcontent</Full>
        <Relative>stringcontent</Relative>
      </Path>
      <ProtectedVm>
        <Identifier>stringcontent</Identifier>
        <Name>stringcontent</Name>
      </ProtectedVm>
      <Size>
        <ProvisionedInBytes>33570816</ProvisionedInBytes>
        <UsedInBytes>441450496</UsedInBytes>

      </Size>
      <VolumeType>Journal</VolumeType>
      <Vpg>
        <Identifier>stringcontent</Identifier>
        <Name>stringcontent</Name>
      </Vpg>
      </VolumeApi>
    </VolumeApi>
      </Datastore>
        <Identifier>stringcontent</Identifier>
        <Name>stringcontent</Name>
      </Datastore>
      <IsThinProvisioned>true</IsThinProvisioned>
      <OwningVm>
        <Identifier>stringcontent</Identifier>
        <Name>stringcontent</Name>
      </OwningVm>
      <Path>
        <FileName>stringcontent</FileName>
        <Full>[BK4BL08_EQL_DS3]stringcontent</Full>
        <Relative>stringcontent</Relative>
      </Path>
      <ProtectedVm>
        <Identifier>stringcontent</Identifier>
        <Name>stringcontent</Name>
      </ProtectedVm>
      <Size>
        <ProvisionedInBytes>33570816</ProvisionedInBytes>
        <UsedInBytes>441450496</UsedInBytes>
      </Size>
      <VolumeType>Journal</VolumeType>
      <Vpg>
        <Identifier>stringcontent</Identifier>
        <Name>stringcontent</Name>
      </Vpg>
    </VolumeApi>
  </ArrayOfVolumeApi>