VRAs API XML Request and Response Formats

The https://zvm_ip:port/v1/vras API has GET, POST, PUT and DELETE methods:

VRAs API GET Method Response Formats
VRAs API POST Method Request and Response Formats
VRAs API PUT Method Request and Response Formats
VRAs API DELETE Method Response Formats

VRAs API GET Method Response Formats

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

The following is an example response XML body for

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

https://zvm_ip:port/v1/vras/{vraIdentifier}.

<ArrayOfVraApi xmlns="http://schemas.zerto.com/zvm/api">
  <VraApi>
  <DatastoreClusterName>String content</DatastoreClusterName>
  <DatastoreIdentifier>String content</DatastoreIdentifier>
  <DatastoreName>String content</DatastoreName>
  <HostIdentifier>String content</HostIdentifier>
  <HostVersion>String content</HostVersion>
  <IpAddress>String content</IpAddress>

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

  <MemoryInGB>2147483647</MemoryInGB>
  <NetworkIdentifier>String content</NetworkIdentifier>
  <NetworkName>String content</NetworkName>
  <Progress>2147483647</Progress>

  <ProtectedCounters>
    <Vms>2147483647</Vms>
    <Volumes>2147483647</Volumes>
    <Vpgs>2147483647</Vpgs>
  </ProtectedCounters>

  <RecoveryCounters>
    <Vms>2147483647</Vms>
    <Volumes>2147483647</Volumes>
    <Vpgs>2147483647</Vpgs>
  </RecoveryCounters>

  <SelfProtectedVpgs>2147483647</SelfProtectedVpgs>
  <Status>Installed</Status>
  <VraGroup>String content</VraGroup>
  <VraIdentifier>18446744073709551615</VraIdentifier>
  <VraName>String content</VraName>

  <VraNetworkDataApi>
    <DefaultGateway>String content</DefaultGateway>
    <SubnetMask>String content</SubnetMask>
    <VraIPAddress>String content</VraIPAddress>
    <VraIPConfigurationTypeApi>String content</VraIPConfigurationTypeApi>
  </VraNetworkDataApi>

  <VraVersion>String content</VraVersion>
  </VraApi>
...
</ArrayOfVraApi>

The following is an example response XML body for

https://zvm_ip:port/v1/vras/ipconfigurationtypes and for https://zvm_ip:port/v1/vras/statuses.

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

VRAs API POST Method Request and Response Formats

The https://zvm_ip:port/v1/vras 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/vras.

<VraCreateDataApi xmlns="http://schemas.zerto.com/zvm/api">
  <DatastoreIdentifier>String content</DatastoreIdentifier>
  <GroupName>String content</GroupName>
  <HostIdentifier>String content</HostIdentifier>
  <HostRootPassword>String content</HostRootPassword>
  <MemoryInGb>2147483647</MemoryInGb>
  <NetworkIdentifier>String content</NetworkIdentifier>
  <UsePublicKeyInsteadOfCredentials>true</UsePublicKeyInsteadOfCredentials>
  <VraNetworkDataApi>
    <DefaultGateway>String content</DefaultGateway>
    <SubnetMask>String content</SubnetMask>
    <VraIPAddress>String content</VraIPAddress>
    <VraIPConfigurationTypeApi>String content</VraIPConfigurationTypeApi>
  </VraNetworkDataApi>
</VraCreateDataApi>

Response Body Format

The following is an example response XML body for https://zvm_ip:port/v1/vras and for https://zvm_ip:port/v1/vras/{vraIdentifier}/upgrade.

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

VRAs API PUT Method Request and Response Formats

The https://zvm_ip:port/v1/vras PUT APIs have both request and response bodies.

Request Body Format

The following is an example request XML body for https://zvm_ip:port/v1/vras/{vraIdentifier}.

<VraEditDataApi xmlns="http://schemas.zerto.com/zvm/api">
  <GroupName>String content</GroupName>
  <HostRootPassword>String content</HostRootPassword>
  <UsePublicKeyInsteadOfCredentials>true</UsePublicKeyInsteadOfCredentials>
  <VraNetworkDataApi>
    <DefaultGateway>String content</DefaultGateway>
    <SubnetMask>String content</SubnetMask>
    <VraIPAddress>String content</VraIPAddress>
    <VraIPConfigurationTypeApi>String content</VraIPConfigurationTypeApi>
  </VraNetworkDataApi>
</VraEditDataApi>

Response Body Format

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

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

VRAs API DELETE Method Response Formats

The https://zvm_ip:port/v1/vras/{vraIdentifier} DELETE API has a response body.

Response Body Format

The following is an example response XML body for https://zvm_ip:port/v1/vras/{vraIdentifier}.f

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