Zerto Virtual Replication APIs : Tasks API : URL
  
URL
All tasks
https://zvm_ip:port/v1/tasks
Filtered tasks
https://zvm_ip:port/v1/tasks?startedBeforeDate={STARTEDBEFOREDATE}&startedAfterDate={STARTEDAFTERDATE}&completedBeforeDate={COMPLETEDBEFOREDATE}&completedAfterDate={COMPLETEDAFTERDATE}&type={TYPE}&status={STATUS}
Single task
https://zvm_ip:port/v1/tasks/{taskIdentifier}
Valid task types
https://zvm_ip:port/v1/tasks/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.
taskIdentifier
The identifier of the task for which information should be returned. The task identifier is the concatenation of the task and site identifiers, separated by a period. For example, 5e81d46e-c49e-4b2c-b65a-d742a4939192.d2da8a37-68f0-4464-a70c-abb19683fd01
Filters
Filters are optional and any combination of filters is valid. When no filter is specified, all tasks are returned. Filters are not case-sensitive.
 
Filter
Description
 
startedBeforeDate
The date before which the tasks must have begun, supplied in the format yyyy-mm-dd. You can also specify a local time in the format: yyyy-mm-ddThh:mm:ss. Adding Z to the end of the time sets the time to UTC.
 
startedAfterDate
The date after which the tasks must have begun, supplied in the format yyyy-mm-dd. You can also specify a local time in the format: yyyy-mm-ddThh:mm:ss. Adding Z to the end of the time sets the time to UTC.
 
completedBeforeDate
The date before which the tasks must have ended, supplied in the format yyyy-mm-dd. You can also specify a local time in the format: yyyy-mm-ddThh:mm:ss. Adding Z to the end of the time sets the time to UTC.
 
completedAfterDate
The date after which the tasks must have ended, supplied in the format yyyy-mm-dd. You can also specify a local time in the format: yyyy-mm-ddThh:mm:ss. Adding Z to the end of the time sets the time to UTC.
 
type
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 CreateProtectionGroup
1 or RemoveProtectionGroup
2 or FailOver
3 or FailOverTest
4 or StopFailOverTest
5 or Move
6 or GetCheckpointList
7 or ProtectVM
8 or UnprotectVM
9 or AddVMToProtectionGroup
10 or RemoveVMFromProtectionGroup
 
 
11 or InstallVra
12 or UninstallVra
13 or GetVMSettings
14 or UpdateProtectionGroup
15 or InsertTaggedCP
16 or WaitForCP
17 or HandleMirrorPromotion
18 or ActivateAllMirrors
19 or LogCollection
20 or ClearCheckpoints
21 or ForceReconfigurationOfNewVM
22 or ClearSite
23 or ForceRemoveProtectionGroup
24 or ForceUpdateProtectionGroup
25 or ForceKillProtectionGroup
 
 
26 or PrePostScript
27 or InitFullSync
28 or Pair
29 or Unpair
30 or AddPeerVraInfo
31 or RemovePeerVraInfo
32 or InstallCloudConnector
33 or UninstallCloudConnector
34 or HandleFirstSyncDone
 
 
35 or Clone
36 or MoveBeforeCommit
37 or MoveRollback
38 or MoveCommit
39 or UpgradeVRA
40 or MaintainHost
41 or NotSupportedInThisVersion
42 or MoveProtectionGroupToManualOperationNeeded
 
 
43 or FailoverBeforeCommit
44 or FailoverCommit
45 or FailoverRollback
46 or ChangeVraIpSettings
47 or PauseProtectionGroup
48 or ResumeProtectionGroup
49 or BulkUpgradeVras
50 or BulkUninstallVras
51 or ChangeVraPassword
52 or ChangeRecoveryHost
53 or ChangeRecoveryHostForProtectionGroup
 
 
54 or VpgBackup
55 or RedeployCloudConnector
56 or RestoreVpg
57 or VpgDeleteBackup
58 or SubmitSupportTicket
59 or PreScript
60 or PostScript
61 or ChangeVraPasswordIpSettings
62 or FlrJournalMount
63 or FlrJournalUnmount
 
status
The status of the task. Possible values are:
1 or InProgress
3 or Paused
4 or Failed
6 or Completed
7 or Cancelling