Events 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/events and, without the array statement, for

https://zvm_ip:port/v1/events/{eventId}.

<ArrayOfEventApi xmlns="http://schemas.zerto.com/zvm/api">
  <EventApi>
    <Description>String content</Description>
    <EntityType>String content</EntityType>
    <EventCategory>String content</EventCategory>
    <EventCompletedSuccessfully>true</EventCompletedSuccessfully>
    <EventIdentifier>String content</EventIdentifier>
    <EventType>String content</EventType>

    <HelpLink>String content</HelpLink>
    <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_>
    <OccurredOn>2021-06-15T04:31:21.651Z</OccurredOn>

    <RelatedEntities>
      <Alerts>
        <ResourceLink>
          <href>String content</href>
          <identifier>String content</identifier>
          <rel>String content</rel>
          <type>String content</type>
        </ResourceLink>
        ...
      </Alerts>
      <FlrSessions>
        <ResourceLink>
          <href>String content</href>
          <identifier>String content</identifier>
          <rel>String content</rel>
          <type>String content</type>
        </ResourceLink>
        ...
      </FlrSessions>
      <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>
      <Zorgs>
        <ResourceLink>
          <href>String content</href>
          <identifier>String content</identifier>
          <rel>String content</rel>
          <type>String content</type>
        </ResourceLink>
        ...
      </Zorgs>
    </RelatedEntities>

    <SiteIdentifier>String content</SiteIdentifier>
    <SiteName>String content</SiteName>
    <UserName>String content</UserName>

    <Vpgs>
      <VpgApiLink>
        <Link__x007B_0_x007D_>
          <href>String content</href>
          <rel>String content</rel>
          <type>String content</type>
        </Link__x007B_0_x007D_>
        <VpgIdentifier>String content</VpgIdentifier>
        <VpgName>String content</VpgName>
      </VpgApiLink>
      ...
    </Vpgs>

    <ZorgIdentifier>String content</ZorgIdentifier>
    <ZorgName>String content</ZorgName>
  </EventApi>
...
</ArrayOfEventApi>

The following is an example response XML body for

https://zvm_ip:port/v1/events/categories,

https://zvm_ip:port/v1/events/entities, and

https://zvm_ip:port/v1/events/types.

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