Zerto 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.fffZ. 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.fffZ. 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.fffZ. 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.fffZ. Adding Z to the end of the time sets the time to UTC.
 
type
The type of task. For the description of the tasks, refer to the Zerto documentation about monitoring tasks. Possible values are:
0 or FirstUnusedValue
1 or CreateProtectionGroup
2 or RemoveProtectionGroup
3 or FailOver
4 or FailOverTest
5 or StopFailOverTest
6 or Move
7 or GetCheckpointList
8 or ProtectVM
9 or UnprotectVM
10 or AddVMToProtectionGroup
11 or RemoveVMFromProtectionGroup
 
 
12 or InstallVra
13 or UninstallVra
14 or GetVMSettings
15 or UpdateProtectionGroup
16 or InsertTaggedCP
17 or WaitForCP
18 or HandleMirrorPromotion
19 or ActivateAllMirrors
20 or LogCollection
21 or ClearCheckpoints
22 or ForceReconfigurationOfNewVM
23 or ClearSite
24 or ForceRemoveProtectionGroup
25 or ForceUpdateProtectionGroup
26 or ForceKillProtectionGroup
 
 
27 or PrePostScript
28 or InitFullSync
29 or Pair
30 or Unpair
31 or AddPeerVraInfo
32 or RemovePeerVraInfo
33 or InstallCloudConnector
34 or UninstallCloudConnector
35 or HandleFirstSyncDone
 
 
36 or Clone
37 or MoveBeforeCommit
38 or MoveRollback
39 or MoveCommit
40 or UpgradeVRA
41 or MaintainHost
42 or NotSupportedInThisVersion
43 or MoveProtectionGroupToManualOperationNeeded
 
 
44 or FailoverBeforeCommit
45 or FailoverCommit
46 or FailoverRollback
47 or ChangeVraIpSettings
48 or PauseProtectionGroup
49 or ResumeProtectionGroup
50 or BulkUpgradeVras
51 or BulkUninstallVras
52 or ChangeVraPassword
53 or ChangeRecoveryHost
54 or ChangeRecoveryHostForProtectionGroup
 
 
55 or VpgBackup
56 or RedeployCloudConnector
57 or RestoreVpg
58 or VpgDeleteBackup
59 or SubmitSupportTicket
60 or PreScript
61 or PostScript
62 or ChangeVraPasswordIpSettings
63 or FlrJournalMount
64 or FlrJournalUnmount
65 or StartVMsWithOrder
66 or HandleProtectedVmRemovedFromPlatform
67 or HandleProtectedVmAddedToPlatform
68 or SplitCommit
 
status
The status of the task. Possible values are:
1 or InProgress
3 or Paused
4 or Failed
6 or Completed
7 or Cancelling