Tasks 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/tasks and, without the array statement, for https://zvm_ip:port/v1/tasks/{taskIdentifier}.

<ArrayOfTaskApi xmlns="http://schemas.zerto.com/zvm/api">
  <TaskApi>
    <CompleteReason>String content</CompleteReason>
    <Completed>2021-06-15T04:31:21.651Z</Completed>
    <InitiatedBy>String content</InitiatedBy>
    <IsCancellable>true</IsCancellable>
    <Link>
      <href>String content</href>
      <identifier>String content</identifier>
      <rel>String content</rel>
      <type>String content</type>
    </Link>

    <RelatedEntities>
      <Hosts>
        <ResourceLink>
          <href>String content</href>
          <identifier>String content</identifier>
          <rel>String content</rel>
          <type>String content</type>
        </ResourceLink>
        ...
      </Hosts>
      <Sites>
        <ResourceLink>
          <href>String content</href>
          <identifier>String content</identifier>
          <rel>String content</rel>
          <type>String content</type>
        </ResourceLink>
        ...
      </Sites>
      <Vpgs>
        <ResourceLink>
          <href>String content</href>
          <identifier>String content</identifier>
          <rel>String content</rel>
          <type>String content</type>
        </ResourceLink>
        ...
      </Vpgs>
      <FlrSessions>
        <ResourceLink>
          <href>String content</href>
          <identifier>String content</identifier>
          <rel>String content</rel>
          <type>String content</type>
        </ResourceLink>
        ...
      </FlrSessions>
    </RelatedEntities>
    <Started>2021-06-15T04:31:21.651Z

</Started>
    <Status>
      <Progress>2147483647</Progress>
      <State>FirstUnusedValue</State>
    </Status>
    <TaskIdentifier>String content</TaskIdentifier>
    <Type>String content</Type>
  </TaskApi>
...
</ArrayOfTaskApi>

The following is an example response XML body for https://zvm_ip:port/v1/tasks/types.

<ArrayOfstring xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<string>String content</string>
...
</ArrayOfstring