Zerto Virtual Replication APIs : Events API : URL
  
URL
All events
https://zvm_ip:port/v1/events
Filtered events
https://zvm_ip:port/v1/events?startDate={STARTDATE}&endDate={ENDDATE}&vpg={VPG}&vpgIdentifier={VPGIDENTIFIER}&eventType={EVENTTYPE}&siteName={SITENAME}&siteIdentifier={SITEIDENTIFIER}&zorgIdentifier={ZORGIDENTIFIER}&entityType={ENTITYTYPE}&userName={USERNAME}&category={CATEGORY}&eventCategory={CATEGORY}&alertIdentifier={ALERTIDENTIFIER}
Single event
https://zvm_ip:port/v1/events/{eventId}
Valid event categories
https://zvm_ip:port/v1/events/categories
Valid event entities
https://zvm_ip:port/v1/events/entities
Valid event types
https://zvm_ip:port/v1/events/types
Where:
zvm_ip
The IP address of the Zerto Virtual Manager where the API is run.
port
The port to access the Zerto Virtual Manager. The default port is 9669.
eventId
The identifier of the event for which information is returned.
Filters
Filters are optional and any combination of filters is valid. When no filter is specified, all events are returned. Filters are not case-sensitive.
 
Filter
Description
 
startDate
The starting date for the list of events, supplied as a date with the format of the Zerto Virtual Manager where the API runs, for example, yyyy-mm-dd. You can also specify a local time with the following format: yyyy-mm-ddThh:mm:ss. Adding Z to the end of the time sets the time to UTC.
 
endDate
The end date for the list, supplied as a date with the format of the Zerto Virtual Manager where the API runs, for example, yyyy-mm-dd. You can also specify a local time with the following format: yyyy-mm-ddThh:mm:ss. Adding Z to the end of the time sets the time to UTC.
 
vpg, vpgIdentifier
The identifier of the VPG for which you want to return events.
 
eventType
The type of event. For the description of events, refer to the Zerto Virtual Replication documentation about alerts and events. Possible values are:
0 or Unknown
1 or CreateProtectionGroup
2 or RemoveProtectionGroup
3 or FailOver
4 or FailOverTest
5 or StopFailOverTest
6 or Move
7 or ProtectVM
8 or UnprotectVM
9 or InstallVra
 
 
10 or UninstallVra
11 or UpdateProtectionGroup
12 or InsertTaggedCP
13 or HandleMirrorPromotion
14 or ActivateAllMirrors
15 or LogCollection
16 or ForceReconfigurationOfNewVM
17 or ClearSite
18 or ForceRemoveProtectionGroup
19 or ForceUpdateProtectionGroup
 
 
20 or ForceKillProtectionGroup
21 or PrePostScript: Deprecated
22 or InitFullSync
23 or Pair
24 or Unpair
25 or InstallCloudConnector
26 or UninstallCloudConnector
27 or RedeployCloudConnector
28 or ScriptExecutionFailure
29 or SetAdvancedSiteSettings
 
 
30 or Clone
31 or KeepDisk
32 or FailoverBeforeCommit
33 or FailoverCommit
34 or FailoverRollback
35 or MoveBeforeCommit
36 or MoveRollback
37 or MoveCommit
38 or MaintainHost
39 or UpgradeVra
 
 
40 or MoveProtectionGroupToManualOperationNeeded: Deprecated
42 or PauseProtectionGroup
43 or ResumeProtectionGroup
44 or UpgradeZVM: Deprecated
45 or BulkUpgradeVras
46 or BulkUninstallVras
47 or AlertTurnedOn
48 or AlertTurnedOff
 
 
 
50 or ChangeRecoveryHost
51 or BackupProtectionGroup
52 or CleanupProtectionGroupVipDiskbox
53 or RestoreProtectionGroup
54 or PreScript
55 or PostScript
56 or RemoveVmFromVc
57 or ChangeVraPasswordIpSettings
58 or FlrJournalMount
59 or FlrJournalUnmount
60 or Login
61 or StartVMsWithOrder
62 or HostEnteringMaintenanceMode
63 or HostExitingMaintenanceMode
64 or VmRestoredToSnapshot
65 or ProtectedVmRemovedFromHypervisor
66 or ProtectedVmAddedToHypervisor,
67 or PauseProtectionGroupForMissingVm: Deprecated.
68 or ResumeProtectionGroupAfterUserRemovedMissingVm
69 or ResumeProtectionGroupAfterVmReadded: Deprecated.
 
siteName
The name of the site.
 
siteIdentifier
The internal site identifier.
 
zorgIdentifier
The identifier of the ZORG, Zerto organization, defined in the Zerto Cloud Manager.
 
entityType
The type of entity to return. Possible values are:
0 or VPG: The entity is a VPG.
1 or VRA: The entity is a VRA.
2 or Unknown: The entity is unknown.
3 or Site: The entity is the site.
 
userName
The name of the user for which the event occurred. If the event occurred as a result of a task started by the Zerto Virtual Manager, for example, when moving a VPG before the commit stage, the user is System.
 
category
The type of event to return. This filter behaves in the same way as the eventCategory filter. Possible values are:
0 or All: All event types.
1 or Events: The event is not an alert event (not EV0056 nor EV0057).
2 or Alerts: The event is an alert event (EV0056 and EV0057).
 
eventCategory
Backwards compatibility. This filter behaves in the same way as the category filter. If both category and eventCategory filters are specified, only the category filter value is used and the eventCategory filter value is ignored. The type of event to return. Possible values are:
0 or All: All event types.
1 or Events: The event is not an alert event (not EV0056 nor EV0057).
2 or Alerts: The event is an alert event (EV0056 and EV0057).
 
alertIdentifier
The internal alert identifier.