Zerto APIs : Events API : Format
  
Format
Json, XML
Request Body Using Json Format
The request body is empty.
Response In Json Format
The following is an example response Json body for https://zvm_ip:port/v1/events and for https://zvm_ip:port/v1/events/{eventId}.
[{
  "Description": "String content",
  "EntityType":0,
  "EventCategory": "String content",
  "EventCompletedSuccessfully": Boolean,
  "EventIdentifier": "String content",
  "EventType":0,
  "HelpLink": "String content",
  "Link": {
    "href": "String content",
    "identifier": "String content",
    "rel": "String content",
    "type": "String content"
  },
  "Link__x007B_0_x007D_": {
    "href": "String content",
    "rel": "String content",
    "type": "String content"
  },
  "OccurredOn":"\/Date(928142400000+0300)\/",
  "RelatedEntities": {
    "Alerts":[{
      "href": "String content",
      "ma": "String content",
      "rel": "String content",
      "type": "String content"
    }],
    "FlrSessions":[{
      "href": "String content",
      "identifier": "String content",
      "rel": "String content",
      "type": "String content"
    }]
    "Hosts":[{
      "href": "String content",
      "identifier": "String content",`
      "rel": "String content",
      "type": "String content"
    }],
    "Sites":[{
      "href": "String content",
      "identifier": "String content",
      "rel": "String content",
      "type": "String content"
    }],
    "Vpgs":[{
      "href": "String content",
      "identifier": "String content",
      "rel": "String content",
      "type": "String content"
    }],
    "Zorgs":[{
      "href": "String content",
      "identifier": "String content",
      "rel": "String content",
      "type": "String content"
    }]
  },
  "SiteIdentifier": "String content",
  "SiteName": "String content",
  "UserName": "String content",
  "Vpgs":[{
    "Link__x007B_0_x007D_": {
      "href": "String content",
      "rel": "String content",
      "type": "String content"
    },
    "VpgIdentifier": "String content",
    "VpgName": "String content"
  }],
  "ZorgIdentifier": "String content",
  "ZorgName": "String content"
}]
The following is an example response Json body for https://zvm_ip:port/v1/events/categories, https://zvm_ip:port/v1/events/entities, and https://zvm_ip:port/v1/events/types.
["String content"]
XML Response Format
For the XML response format, see “Events API XML Response Format”, on page 353.
Response Values
Response values for https://zvm_ip:port/v1/events and for https://zvm_ip:port/v1/events/{eventId}.
Parameter
Description
Description
A description of the event.
EntityType
The type of entity. Possible values are (Json/XML):
0/VPG: The entity is a VPG.
1/VRA: The entity is a VRA.
2/Unknown: The entity is unknown.
3/Site: The entity is the site.
EventCategory
The type of event. Possible values are:
0/All: All event types.
1/Events: The event is not an alert event (not EV0056 nor EV0057).
2/Alerts: The event is an alert event (EV0056 and EV0057).
EventCompletedSuccessfully
Whether the event completed successfully or not.
EventIdentifier
The unique internal identifier of the event.
EventType
The type of event. Possible values are (Json/XML):
1/Unknown
2/CreateProtectionGroup
3/RemoveProtectionGroup
4/FailOver
5/FailOverTest
6/StopFailOverTest
7/Move
8/ProtectVM
9/UnprotectVM
10/InstallVra
 
11/UninstallVra
12/UpdateProtectionGroup
13/InsertTaggedCP
14/HandleMirrorPromotion
15/ActivateAllMirrors
16/LogCollection
17/ForceReconfigurationOfNewVM
18/ClearSite
19/ForceRemoveProtectionGroup
20/ForceUpdateProtectionGroup
 
21/ForceKillProtectionGroup
22/PrePostScript: Deprecated
23/InitFullSync
24/Pair
25/Unpair
26/InstallCloudConnector
27/UninstallCloudConnector
28/RedeployCloudConnector
29/ScriptExecutionFailure
30/SetAdvancedSiteSettings
 
31/Clone
32/KeepDisk
33/FailoverBeforeCommit
34/FailoverCommit
35/FailoverRollback
36/MoveBeforeCommit
37/MoveRollback
38/MoveCommit
39/MaintainHost
40/UpgradeVra
 
41/MoveProtectionGroupToManualOperationNeeded: Deprecated
42/ChangeVraIpSettings: Deprecated
43/PauseProtectionGroup
44/ResumeProtectionGroup
45/UpgradeZVM: Deprecated
46/BulkUpgradeVras
47/BulkUninstallVras
48/AlertTurnedOn
49/AlertTurnedOff
 
 
51/ChangeRecoveryHost
52/BackupProtectionGroup
53/CleanupProtectionGroupVipDiskbox
54/RestoreProtectionGroup
55/PreScript
56/PostScript
57/RemoveVmFromVc
58/ChangeVraPasswordIpSettings
59/FlrJournalMount
60/FlrJournalUnmount
61/Login
62/HostEnteringMaintenanceMode
63/HostExitingMaintenanceMode
64/VmRestoredToSnapshot
65/ProtectedVmRemovedFromHypervisor
66/ProtectedVmAddedToHypervisor,
67/PauseProtectionGroupForMissingVm: Deprecated
68/ResumeProtectionGroupAfterUserRemovedMissingVm
69/ResumeProtectionGroupAfterVmReadded: Deprecated
70/Cloud
71/StartingInstallerDownload
72/DownloadingZertoInstaller
73/StartingZvmUpgradeRemotely
74/UpgradingZvmRemotely
75/SplitCommit
HelpLink
The link to additional information about the event.
Link
The link details.
href
The URL used.
identifier
The unique internal identifier of the event.
rel
The next path level for the API relative to the current path.
type
The API interface service.
OccurredOn
The date the event occurred. The value can be converted to an understandable date using code similar to the following:
var date = new Date(jsonDate);
or code similar to the Perl code example, jsonDateToString($), in Managing vCD APIs.
RelatedEntities
Entities possibly affected by the event.
Alerts
The alerts affected by the event.
href
The URL used to retrieve alert information.
identifier
The unique internal identifier of the alert.
rel
The next path level for the API relative to the current path.
type
The API interface service.
FlrSessions
The file level restore sessions affected by the event.
href
The URL used to retrieve file level restore session information.
identifier
The unique internal identifier of the file level restore session.
rel
The next path level for the API relative to the current path.
type
The API interface service.
Hosts
The hosts affected by the event.
href
The URL used to retrieve host information.
identifier
The unique internal identifier of the host.
rel
The next path level for the API relative to the current path.
type
The API interface service.
Sites
The sites affected by the event.
href
The URL used to retrieve site information.
identifier
The unique internal identifier of the site where the API runs.
rel
The next path level for the API relative to the current path.
type
The API interface service.
Vpgs
The VPGs affected by the event.
href
The URL used to retrieve VPG information for each VPG affected by the event.
identifier
The unique internal identifier of the VPG.
rel
The next path level for the API relative to the current path.
type
The API interface service.
Zorgs
The ZORGS affected by the event.
href
The URL used to retrieve ZORG information.
identifier
The unique internal identifier of the ZORG.
rel
The next path level for the API relative to the current path.
type
The API interface service.
SiteIdentifier
The internal site identifier.
SiteName
The name of the site where the event occurred.
UserName
The username responsible for the event, system or an administrator user.
Vpgs
The VPGs affected by the event.
Link
The link to the specific VPG.
href
The URL used to retrieve VPG information for each VPG affected by the event.
rel
The next path level for the API relative to the current path.
type
The API interface service.
VpgIdentifier
The internal VPG identifier.
VpgName
The name of the VPG.
ZorgIdentifier
The identifier of the ZORG, Zerto organization, defined in the Zerto Cloud Manager.
ZorgName
The name of the Zerto organization, defined by a Zerto Cloud Manager, where the event occurred.
Response values for https://zvm_ip:port/v1/events/categories.
Response: Description
Event categories:
All: All event types.
Events: The event is not an alert event (not EV0056 nor EV0057).
Alerts: The event is an alert event (EV0056 and EV0057).
Response values for https://zvm_ip:port/v1/events/entities.
Response: Description
Entity types:
VPG: The entity is a VPG.
VRA: The entity is a VRA.
Unknown: The entity is unknown.
Site: The entity is the site.
Response values for https://zvm_ip:port/v1/events/types.
Response: Description
Event types:
Unknown
CreateProtectionGroup
RemoveProtectionGroup
FailOver
FailOverTest
StopFailOverTest
Move
ProtectVM
UnprotectVM
InstallVra
UninstallVra
UpdateProtectionGroup
InsertTaggedCP
HandleMirrorPromotion
ActivateAllMirrors
LogCollection
ForceReconfigurationOfNewVM
ClearSite
ForceRemoveProtectionGroup
ForceUpdateProtectionGroup
ForceKillProtectionGroup
PrePostScript: Deprecated
InitFullSync
Pair
Unpair
InstallCloudConnector
UninstallCloudConnector
RedeployCloudConnector
ScriptExecutionFailure
SetAdvancedSiteSettings
Clone
KeepDisk
FailoverBeforeCommit
FailoverCommit
FailoverRollback
MoveBeforeCommit
MoveRollback
MoveCommit
MaintainHost
UpgradeVra
MoveProtectionGroupToManualOperationNeeded: Deprecated
ChangeVraIpSettings: Deprecated
PauseProtectionGroup
ResumeProtectionGroup
UpgradeZVM: Deprecated
BulkUpgradeVras
BulkUninstallVras
AlertTurnedOn
AlertTurnedOff
ChangeRecoveryHost
BackupProtectionGroup
CleanupProtectionGroupVipDiskbox
RestoreProtectionGroup
PreScript
PostScript
RemoveVmFromVc
ChangeVraPasswordIpSettings
FlrJournalMount
FlrJournalUnmount
Login
HostEnteringMaintenanceMode
HostExitingMaintenanceMode
VmRestoredToSnapshot
ProtectedVmRemovedFromHypervisor
ProtectedVmAddedToHypervisor,
PauseProtectionGroupForMissingVm: Deprecated
ResumeProtectionGroupAfterUserRemovedMissingVm
ResumeProtectionGroupAfterVmReadded: Deprecated
PowerShell Scripts
For complete PowerShell Scripts, see “Examples”, on page 23.