XML Request and Response Formats : VPG Settings API XML Request and Response Formats : GET Method Request and Response Formats
  
GET Method Request and Response Formats
Request Body Formats
All GET method request bodies are empty.
Response Body Formats
The https://zvm_ip:port/v1/vpgSettings GET APIs have response bodies.
The following is an example response XML body for https://zvm_ip:port/v1/vpgSettings and, without the array statement, for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}.
<ArrayOfVpgSettingsApi xmlns="http://schemas.zerto.com/zvm/api">
  <VpgSettingsApi>
    <Backup>
      <RepositoryIdentifier>String content</RepositoryIdentifier>
      <RetentionPeriod>String content</RetentionPeriod>
      <Retry>
        <IntervalInMinutes>2147483647</IntervalInMinutes>
        <Number>2147483647</Number>
        <Retry>true</Retry>
      </Retry>
      <Scheduler>
        <DayOfWeek>String content</DayOfWeek>
        <SchedulerPeriod>String content</SchedulerPeriod>
        <TimeOfDay>String content</TimeOfDay>
      </Scheduler>
    </Backup>
    <Basic>
      <JournalHistoryInHours>2147483647</JournalHistoryInHours>
      <Name>String content</Name>
      <Priority>String content</Priority>
      <ProtectedSiteIdentifier>String content</ProtectedSiteIdentifier>
      <RecoverySiteIdentifier>String content</RecoverySiteIdentifier>
      <RpoInSeconds>4294967295</RpoInSeconds>
      <ServiceProfileIdentifier>String content</ServiceProfileIdentifier>
      <TestIntervalInMinutes>2147483647</TestIntervalInMinutes>
      <UseWanCompression>true</UseWanCompression>
      <ZorgIdentifier>String content</ZorgIdentifier>
    </Basic>
    <BootGroups>
      <BootGroups>
        <VpgSettingsBootGroupApi>
          <BootDelayInSeconds>4294967295</BootDelayInSeconds>
          <BootGroupIdentifier>String content</BootGroupIdentifier>
          <Name>String content</Name>
        </VpgSettingsBootGroupApi>
        <VpgSettingsBootGroupApi>
           …
        </VpgSettingsBootGroupApi>
      </BootGroups>
    </BootGroups>
    <Journal>
      <DatastoreClusterIdentifier>String content</DatastoreClusterIdentifier>
      <DatastoreIdentifier>String content</DatastoreIdentifier>
      <Limitation>
        <HardLimitInMB>2147483647</HardLimitInMB>
        <HardLimitInPercent>2147483647</HardLimitInPercent>
        <WarningThresholdInMB>2147483647</WarningThresholdInMB>
        <WarningThresholdInPercent>2147483647</WarningThresholdInPercent>
      </Limitation>
    </Journal>
    <Networks>
      <Failover>
        <Hypervisor>
          <DefaultNetworkIdentifier>String content</DefaultNetworkIdentifier>
        </Hypervisor>
      </Failover>
      <FailoverTest>
        <Hypervisor>
          <DefaultNetworkIdentifier>String content</DefaultNetworkIdentifier>
        </Hypervisor>
      </FailoverTest>
    </Networks>
    <Recovery>
      <DefaultDatastoreClusterIdentifier>String content</DefaultDatastoreClusterIdentifier>
      <DefaultDatastoreIdentifier>String content</DefaultDatastoreIdentifier>
      <DefaultFolderIdentifier>String content</DefaultFolderIdentifier>
      <DefaultHostClusterIdentifier>String content</DefaultHostClusterIdentifier>
      <DefaultHostIdentifier>String content</DefaultHostIdentifier>
      <ResourcePoolIdentifier>String content</ResourcePoolIdentifier>
    </Recovery>
    <Scripting>
      <PostBackup>
        <Command>String content</Command>
        <Parameters>String content</Parameters>
        <TimeoutInSeconds>2147483647</TimeoutInSeconds>
      </PostBackup>
      <PostRecovery>
        <Command>String content</Command>
        <Parameters>String content</Parameters>
        <TimeoutInSeconds>2147483647</TimeoutInSeconds>
      </PostRecovery>
      <PreRecovery>
        <Command>String content</Command>
        <Parameters>String content</Parameters>
        <TimeoutInSeconds>2147483647</TimeoutInSeconds>
      </PreRecovery>
    </Scripting>
    <Vms>
      <VpgSettingsVmApi>
        <BootGroupIdentifier>String content</BootGroupIdentifier>
        <Journal>
          <DatastoreClusterIdentifier>String content</DatastoreClusterIdentifier>
          <DatastoreIdentifier>String content</DatastoreIdentifier>
          <Limitation>
            <HardLimitInMB>4294967295</HardLimitInMB>
            <HardLimitInPercent>4294967295</HardLimitInPercent>
            <WarningThresholdInMB>4294967295</WarningThresholdInMB>
            <WarningThresholdInPercent>4294967295</WarningThresholdInPercent>
          </Limitation>
        </Journal>
        <Nics>
          <VpgSettingsVmNicApi>
            <Failover>
              <Hypervisor>
                <DnsSuffix>String content</DnsSuffix>
                <IpConfig>
                  <Gateway>String content</Gateway>
                  <IsDhcp>true</IsDhcp>
                  <PrimaryDns>String content</PrimaryDns>
                  <SecondaryDns>String content</SecondaryDns>
                  <StaticIp>String content</StaticIp>
                  <SubnetMask>String content</SubnetMask>
                </IpConfig>
                <NetworkIdentifier>String content</NetworkIdentifier>
                <ShouldReplaceMacAddress>true</ShouldReplaceMacAddress>
              </Hypervisor>
            </Failover>
            <FailoverTest>
              <Hypervisor>
                <DnsSuffix>String content</DnsSuffix>
                <IpConfig>
                  <Gateway>String content</Gateway>
                  <IsDhcp>true</IsDhcp>
                  <PrimaryDns>String content</PrimaryDns>
                  <SecondaryDns>String content</SecondaryDns>
                  <StaticIp>String content</StaticIp>
                  <SubnetMask>String content</SubnetMask>
                </IpConfig>
                <NetworkIdentifier>String content</NetworkIdentifier>
                <ShouldReplaceMacAddress>true</ShouldReplaceMacAddress>
              </Hypervisor>
            </FailoverTest>
            <NicIdentifier>String content</NicIdentifier>
          </VpgSettingsVmNicApi>
          <VpgSettingsVmNicApi>
            <Failover>
              …
            </Failover>
            <FailoverTest>
              …
            </FailoverTest>
            <NicIdentifier>String content</NicIdentifier>
          </VpgSettingsVmNicApi>
        </Nics>
        <Recovery>
          <DatastoreClusterIdentifier>String content</DatastoreClusterIdentifier>
          <DatastoreIdentifier>String content</DatastoreIdentifier>
          <FolderIdentifier>String content</FolderIdentifier>
          <HostClusterIdentifier>String content</HostClusterIdentifier>
          <HostIdentifier>String content</HostIdentifier>
          <ResourcePoolIdentifier>String content</ResourcePoolIdentifier>
        </Recovery>
        <VmIdentifier>String content</VmIdentifier>
        <Volumes>
          <VpgSettingsVmVolumeApi>
            <Datastore>
              <DatastoreClusterIdentifier>String content</DatastoreClusterIdentifier>
              <DatastoreIdentifier>String content</DatastoreIdentifier>
              <IsThin>true</IsThin>
            </Datastore>
            <ExistingVolume>
              <DatastoreIdentifier>String content</DatastoreIdentifier>
              <ExistedVmIdentifier>String content</ExistedVmIdentifier>
              <Mode>String content</Mode>
              <Path>String content</Path>
            </ExistingVolume>
            <IsSwap>true</IsSwap>
            <VolumeIdentifier>String content</VolumeIdentifier>
          </VpgSettingsVmVolumeApi>
          <VpgSettingsVmVolumeApi>
            …
          </VpgSettingsVmVolumeApi>
        </Volumes>
      </VpgSettingsVmApi>
      <VpgSettingsVmApi>
        …
      </VpgSettingsVmApi>
    </Vms>
    <VpgIdentifier>String content</VpgIdentifier>
    <VpgSettingsIdentifier>String content</VpgSettingsIdentifier>
  </VpgSettingsApi>
  <VpgSettingsApi>
    …
  </VpgSettingsApi>
</ArrayOfVpgSettingsApi>
The following is an example response XML body for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/backup.
<VpgSettingsBackupApi xmlns="http://schemas.zerto.com/zvm/api">
  <RepositoryIdentifier>String content</RepositoryIdentifier>
  <RetentionPeriod>String content</RetentionPeriod>
  <Retry>
    <IntervalInMinutes>2147483647</IntervalInMinutes>
    <Number>2147483647</Number>
    <Retry>true</Retry>
  </Retry>
  <Scheduler>
    <DayOfWeek>String content</DayOfWeek>
    <SchedulerPeriod>String content</SchedulerPeriod>
    <TimeOfDay>String content</TimeOfDay>
  </Scheduler>
</VpgSettingsBackupApi>
The following is an example response XML body for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/backup/dayofweek, https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/backup/retentionperiod, and for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/backup/schedulerperiod.
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">String content</string>
The following is an example response XML body for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/basic.
<VpgSettingsBasicApi xmlns="http://schemas.zerto.com/zvm/api">
  <JournalHistoryInHours>2147483647</JournalHistoryInHours>
  <Name>String content</Name>
  <Priority>String content</Priority>
  <ProtectedSiteIdentifier>String content</ProtectedSiteIdentifier>
  <RecoverySiteIdentifier>String content</RecoverySiteIdentifier>
  <RpoInSeconds>4294967295</RpoInSeconds>
  <ServiceProfileIdentifier>String content</ServiceProfileIdentifier>
  <TestIntervalInMinutes>2147483647</TestIntervalInMinutes>
  <UseWanCompression>true</UseWanCompression>
  <ZorgIdentifier>String content</ZorgIdentifier>
</VpgSettingsBasicApi>
The following is an example response XML body for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/bootgroup.
<VpgSettingsBootGroupsApi xmlns="http://schemas.zerto.com/zvm/api">
  <BootGroups>
    <VpgSettingsBootGroupApi>
      <BootDelayInSeconds>4294967295</BootDelayInSeconds>
      <BootGroupIdentifier>String content</BootGroupIdentifier>
      <Name>String content</Name>
    </VpgSettingsBootGroupApi>
    <VpgSettingsBootGroupApi>
      <BootDelayInSeconds>4294967295</BootDelayInSeconds>
      <BootGroupIdentifier>String content</BootGroupIdentifier>
      <Name>String content</Name>
    </VpgSettingsBootGroupApi>
  </BootGroups>
</VpgSettingsBootGroupsApi>
The following is an example response XML body for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/journal.
<VpgSettingsJournalApi xmlns="http://schemas.zerto.com/zvm/api">
  <DatastoreIdentifier>String content</DatastoreIdentifier>
  <Limitation>
    <HardLimitInMB>2147483647</HardLimitInMB>
    <HardLimitInPercent>2147483647</HardLimitInPercent>
    <WarningThresholdInMB>2147483647</WarningThresholdInMB>
    <WarningThresholdInPercent>2147483647</WarningThresholdInPercent>
  </Limitation>
</VpgSettingsJournalApi>
The following is an example response XML body for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/networks.
<VpgSettingsNetworksApi xmlns="http://schemas.zerto.com/zvm/api">
  <Failover>
    <Hypervisor>
      <DefaultNetworkIdentifier>String content</DefaultNetworkIdentifier>
    </Hypervisor>
  </Failover>
  <FailoverTest>
    <Hypervisor>
      <DefaultNetworkIdentifier>String content</DefaultNetworkIdentifier>
    </Hypervisor>
  </FailoverTest>
</VpgSettingsNetworksApi>
The following is an example response XML body for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/priority.
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">String content</string>
The following is an example response XML body for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/recovery.
<VpgSettingsRecoveryApi xmlns="http://schemas.zerto.com/zvm/api">
  <DefaultDatastoreClusterIdentifier>String content</DefaultDatastoreClusterIdentifier>
  <DefaultDatastoreIdentifier>String content</DefaultDatastoreIdentifier>
  <DefaultFolderIdentifier>String content</DefaultFolderIdentifier>
  <DefaultHostClusterIdentifier>String content</DefaultHostClusterIdentifier>
  <DefaultHostIdentifier>String content</DefaultHostIdentifier>
  <ResourcePoolIdentifier>String content</ResourcePoolIdentifier>
</VpgSettingsRecoveryApi>
The following is an example response XML body for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/scripting.
<VpgSettingsScriptsApi xmlns="http://schemas.zerto.com/zvm/api">
  <PostBackup>
    <Command>String content</Command>
    <Parameters>String content</Parameters>
    <TimeoutInSeconds>2147483647</TimeoutInSeconds>
  </PostBackup>
  <PostRecovery>
    <Command>String content</Command>
    <Parameters>String content</Parameters>
    <TimeoutInSeconds>2147483647</TimeoutInSeconds>
  </PostRecovery>
  <PreRecovery>
    <Command>String content</Command>
    <Parameters>String content</Parameters>
    <TimeoutInSeconds>2147483647</TimeoutInSeconds>
  </PreRecovery>
</VpgSettingsScriptsApi>
The following is an example response XML body for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms and, without the array statement, for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}.
<ArrayOfVpgSettingsVmApi xmlns="http://schemas.zerto.com/zvm/api">
  <VpgSettingsVmApi>
    <BootGroupIdentifier>String content</BootGroupIdentifier>
    <Journal>
    <DatastoreClusterIdentifier>String content</DatastoreClusterIdentifier>
    <DatastoreIdentifier>String content</DatastoreIdentifier>
    <Limitation>
      <HardLimitInMB>4294967295</HardLimitInMB>
      <HardLimitInPercent>4294967295</HardLimitInPercent>
      <WarningThresholdInMB>4294967295</WarningThresholdInMB>
      <WarningThresholdInPercent>4294967295</WarningThresholdInPercent>
      </Limitation>
    </Journal>
    <Nics>
      <VpgSettingsVmNicApi>
        <Failover>
          <Hypervisor>
            <DnsSuffix>String content</DnsSuffix>
            <IpConfig>
              <Gateway>String content</Gateway>
              <IsDhcp>true</IsDhcp>
              <PrimaryDns>String content</PrimaryDns
              <SecondaryDns>String content</SecondaryDns>
              <StaticIp>String content</StaticIp>
              <SubnetMask>String content</SubnetMask>
            </IpConfig>
            <NetworkIdentifier>String content</NetworkIdentifier>
            <ShouldReplaceMacAddress>true</ShouldReplaceMacAddress>
          </Hypervisor>
        </Failover>
        <FailoverTest>
          <Hypervisor>
            <DnsSuffix>String content</DnsSuffix>
            <IpConfig>
              <Gateway>String content</Gateway>
              <IsDhcp>true</IsDhcp>
              <PrimaryDns>String content</PrimaryDns
              <SecondaryDns>String content</SecondaryDns>
              <StaticIp>String content</StaticIp>
              <SubnetMask>String content</SubnetMask>
            </IpConfig>
            <NetworkIdentifier>String content</NetworkIdentifier>
            <ShouldReplaceMacAddress>true</ShouldReplaceMacAddress>
          </Hypervisor>
        </FailoverTest>
        <NicIdentifier>String content</NicIdentifier>
      </VpgSettingsVmNicApi>
      <VpgSettingsVmNicApi>
        <Failover>
          ...
        </Failover>
        <FailoverTest>
          ...
        </FailoverTest>
        <NicIdentifier>String content</NicIdentifier>
      </VpgSettingsVmNicApi>
    </Nics>
    <Recovery>
      <DatastoreClusterIdentifier>String content</DatastoreClusterIdentifier>
      <DatastoreIdentifier>String content</DatastoreIdentifier>
      <FolderIdentifier>String content</FolderIdentifier>
      <HostClusterIdentifier>String content</HostClusterIdentifier>
      <HostIdentifier>String content</HostIdentifier>
      <ResourcePoolIdentifier>String content</ResourcePoolIdentifier>
    </Recovery>
    <VmIdentifier>String content</VmIdentifier>
    <Volumes>
      <VpgSettingsVmVolumeApi>
        <Datastore>
          <DatastoreClusterIdentifier>String content</DatastoreClusterIdentifier>
          <DatastoreIdentifier>String content</DatastoreIdentifier>
          <IsThin>true</IsThin>
        </Datastore>
        <ExistingVolume>
          <DatastoreIdentifier>String content</DatastoreIdentifier>
          <ExistedVmIdentifier>String content</ExistedVmIdentifier>
          <Mode>String content</Mode>
          <Path>String content</Path>
        </ExistingVolume>
        <IsSwap>true</IsSwap>
        <VolumeIdentifier>String content</VolumeIdentifier>
      </VpgSettingsVmVolumeApi>
      <VpgSettingsVmVolumeApi>
        …
      </VpgSettingsVmVolumeApi>
    </Volumes>
  </VpgSettingsVmApi>
  </VpgSettingsVmApi>
    ...
  </VpgSettingsVmApi>
</ArrayOfVpgSettingsVmApi>
The following is an example response XML body for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/nics and, without the array statement, for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/nics/{nicIdentifier}.
<ArrayOfVpgSettingsVmNicApi xmlns="http://schemas.zerto.com/zvm/api">
  <VpgSettingsVmNicApi>
    <Failover>
      <Hypervisor>
        <DnsSuffix>String content</DnsSuffix>
        <IpConfig>
          <Gateway>String content</Gateway>
          <IsDhcp>true</IsDhcp>
          <PrimaryDns>String content</PrimaryDns>
          <SecondaryDns>String content</SecondaryDns>
          <StaticIp>String content</StaticIp>
          <SubnetMask>String content</SubnetMask>
        </IpConfig>
        <NetworkIdentifier>String content</NetworkIdentifier>
        <ShouldReplaceMacAddress>true</ShouldReplaceMacAddress>
      </Hypervisor>
    </Failover>
    <FailoverTest>
      <Hypervisor>
        <DnsSuffix>String content</DnsSuffix>
        <IpConfig>
          <Gateway>String content</Gateway>
          <IsDhcp>true</IsDhcp>
          <PrimaryDns>String content</PrimaryDns>
          <SecondaryDns>String content</SecondaryDns>
          <StaticIp>String content</StaticIp>
          <SubnetMask>String content</SubnetMask>
        </IpConfig>
        <NetworkIdentifier>String content</NetworkIdentifier>
        <ShouldReplaceMacAddress>true</ShouldReplaceMacAddress>
      </Hypervisor>
    </FailoverTest>
    <NicIdentifier>String content</NicIdentifier>
  </VpgSettingsVmNicApi>
  <VpgSettingsVmNicApi>
    <Failover>
       ...
    </Failover>
    <FailoverTest>
       ...
    </FailoverTest>
    <NicIdentifier>String content</NicIdentifier>
  </VpgSettingsVmNicApi>
</ArrayOfVpgSettingsVmNicApi>
The following is an example response XML body for https://zvm_ip:port/v1/vpgSettings/{vpgSettingsIdentifier}/vms/{vmIdentifier}/volumes and, without the array statement, for https://zvm_ip:port/v1/vpgSettings/volumes/{volumeId}.
<ArrayOfVpgSettingsVmVolumeApi xmlns="http://schemas.zerto.com/zvm/api">
  <VpgSettingsVmVolumeApi>
    <Datastore>
      <DatastoreIdentifier>String content</DatastoreIdentifier>
      <IsThin>true</IsThin>
    </Datastore>
    <ExistingVolume>
      <DatastoreIdentifier>String content</DatastoreIdentifier>
      <ExistedVmIdentifier>String content</ExistedVmIdentifier>
      <Mode>String content</Mode>
      <Path>String content</Path>
    </ExistingVolume>
    <IsSwap>true</IsSwap>
    <VolumeIdentifier>String content</VolumeIdentifier>
  </VpgSettingsVmVolumeApi>
  <VpgSettingsVmVolumeApi>
    <Datastore>
      <DatastoreClusterIdentifier>String content</DatastoreClusterIdentifier>
      <DatastoreIdentifier>String content</DatastoreIdentifier>
      <IsThin>true</IsThin>
    </Datastore>
    <ExistingVolume>
      <DatastoreIdentifier>String content</DatastoreIdentifier>
      <ExistedVmIdentifier>String content</ExistedVmIdentifier>
      <Mode>String content</Mode>
      <Path>String content</Path>
    </ExistingVolume>
    <IsSwap>true</IsSwap>
    <VolumeIdentifier>String content</VolumeIdentifier>
  </VpgSettingsVmVolumeApi>
</ArrayOfVpgSettingsVmVolumeApi>