VPGs API XML Request and Response Formats

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 https://zvm_ip:port/v1/vpgs API has GET, POST and DELETE methods:

VPGs API GET Method Response Formats

VPGs API POST Method Request and Response Formats

VPGs API DELETE Method Request and Response Formats

VPGs API GET Method Response Formats

The https://zvm_ip:port/v1/vpgs GET APIs have response bodies.

Response Body Format

The following is an example response XML body for

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

https://zvm_ip:port/v1/vpgs/{protectionGroupIdentifier}.

<ArrayOfVpgApi xmlns="http://schemas.zerto.com/zvm/api">
  <VpgApi>
  <ActiveProcessesApi>
    <RunningFailOverTestApi>
      <Stage>String content</Stage>
    </RunningFailOverTestApi>
  </ActiveProcessesApi>
  <ActualRPO>2147483647</ActualRPO>
  <BackupEnabled>true</BackupEnabled>

  <Entities>
    <Protected>VCVpg</Protected>
    <Recovery>VCVpg</Recovery>
    <Source>VCVpg</Source>
    <Target>VCVpg</Target>
  </Entities>

  <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>
  <ProgressPercentage>1.26743233E+15</ProgressPercentage>

  <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>

  <ServiceProfile>
    <href>String content</href>
    <identifier>String content</identifier>
    <rel>String content</rel>
    <type>String content</type>
  </ServiceProfile>

  <ServiceProfileIdentifier>String content</ServiceProfileIdentifier>
  <ServiceProfileName>String content</ServiceProfileName>
  <SourceSite>String content</SourceSite>
  <Status>Initializing</Status>
  <SubStatus>None</SubStatus>

  <TargetSite>String content</TargetSite>
  <ThroughputInMB>1.26743233E+15</ThroughputInMB>
  <UsedStorageInMB>2147483647</UsedStorageInMB>
  <VmsCount>2147483647</VmsCount>
  <VpgIdentifier>String content</VpgIdentifier>
  <VpgName>String content</VpgName>

  <Zorg>
    <href>String content</href>
    <identifier>String content</identifier>
    <rel>String content</rel>
    <type>String content</type>
  </Zorg>

</VpgApi>
...
</ArrayOfVpgApi>

The following is an example response XML body for

https://zvm_ip:port/v1/vpgs/{protectionGroupIdentifier}/checkpoints/summary.

The following is an example response XML body for

https://zvm_ip:port/v1/vpgs/{protectionGroupIdentifier}/checkpoints.

<ArrayOfCheckpointApi xmlns="http://schemas.zerto.com/zvm/api">
  <CheckpointApi>
    <CheckpointId>String content</CheckpointId>
    <Tag>String content</Tag>
    <TimeStamp>2021-06-15T04:31:21.651Z</TimeStamp>
  </CheckpointApi>
...
</ArrayOfCheckpointApi>

The following is an example response XML body for

https://zvm_ip:port/v1/vpgs/entitytypes,

https://zvm_ip:port/v1/vpgs/failovercommitpolicies,

https://zvm_ip:port/v1/vpgs/failovershutdownpolicies,

https://zvm_ip:port/v1/vpgs/priorities,

https://zvm_ip:port/v1/vpgs/retentionpolicies,

https://zvm_ip:port/v1/vpgs/statuses, and for

https://zvm_ip:port/v1/vpgs/substatuses.

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

VPGs API POST Method Request and Response Formats

The https://zvm_ip:port/v1/vpgs POST APIs have both request and response bodies.

Request Body Format

The following is an example request XML body for https://zvm_ip:port/v1/vpgs.

<VpgCreateDataApi xmlns="http://schemas.zerto.com/zvm/api">
  <DatastoreIdentifier>String content</DatastoreIdentifier>
  <OrgVdcIdentifier>String content</OrgVdcIdentifier>
  <Priority>Low</Priority>
  <ResourcePoolIdentifier>String content</ResourcePoolIdentifier>
  <ServiceProfileIdentifier>String content</ServiceProfileIdentifier>
  <SourceSiteIdentifier>String content</SourceSiteIdentifier>
  <TargetSiteIdentifier>String content</TargetSiteIdentifier>
  <VcVappIdentifier>String content</VcVappIdentifier>
  <VcdVappIdentifier>String content</VcdVappIdentifier>
  <VmsIdentifiers>
    <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string>
    <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string>
  </VmsIdentifiers>~
  <VpgName>String content</VpgName>
  <ZorgIdentifier>String content</ZorgIdentifier>
</VpgCreateDataApi>