Zerto Virtual Replication APIs : Tasks API
  
Tasks API
/v1/tasks returns information about tasks run on the site.
URI
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 task.
 
status
The status of the task.
HTTP Method
GET
Security
The API is exposed over HTTPS. Client code must use the x-zerto-session HTTP authorization header.
See Also
Starting a session: https://zvm_ip:port/v1/session – POST Method
Return the details of the peer sites – Peer Sites API
Return the details of the local site – Local Site API
Format
Json, XML
Request Format
The request body is empty.
Json Response Format
The following is an example response Json body for https://zvm_ip:port/v1/tasks and for https://zvm_ip:port/v1/tasks/{taskidentifier}
[{
  "CompleteReason":"String content",
  "Completed":"\/Date(928142400000+0300)\/",
  "InitiatedBy":"String content",
  "IsCancellable":Boolean,
  "Link":{
    "href":"String content",
    "identifier":"String content",
    "rel":"String content",
    "type":"String content"
  },
  "RelatedEntities":{
    "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"
    }]
    "FlrSessions":[{
      "href":"String content",
      "identifier":"String content",
      "rel":"String content",
      "type":"String content"
    }]
  },
  "Started":"\/Date(928142400000+0300)\/",
  "Status":{
    "Progress":2147483647,
    "State":0
  },
  "TaskIdentifier":"String content",
  "Type":"String content"
}]
XML Response Format
For the XML response format, see Tasks API XML Response Format.
Response Values
Response values for https://zvm_ip:port/v1/tasks and for https://zvm_ip:port/v1/task/{taskidentifier}.
Parameter
Description
CompleteReason
The reason the task completed.
Completed
The date the task completed. 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 Perl Code Example: Retrieving the First 100 Records.
InitiatedBy
The name of the user who initiated the task.
IsCancellable
true – The task can be canceled via user intervention.
false – The task cannot be canceled via user intervention.
Link
The link details.
href
The URL used.
identifier
The unique identifier of the task.
rel
The next path level for the API relative to the current path.
type
The API interface service.
RelatedEntities
Entities possibly affected by the event.
Hosts
The hosts affected by the task.
href
The URL used to retrieve host information for each host affected by the event.
identifier
The unique internal identifier of the host where the API runs.
rel
The next path level for the API relative to the current path.
type
The API interface service.
Sites
The sites affected by the task.
href
The URL used to retrieve site information: peersites and localsite APIs.
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 task.
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.
FlrSessions
The file level restore sessions affected by the task.
href
The URL used to retrieve file level restore session information for each session affected by the event.
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.
Started
The date the task started. 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 Perl Code Example: Retrieving the First 100 Records.
Status
The status of the task.
Progress
The progress of the task.
State
The state of the task. Possible values are (Json/XML):
0/FirstUnusedValue
1/InProgress
2/WaitingForUserInput
3/Paused
4/Failed
5/Stopped
6/Completed
7/Cancelling
TaskIdentifier
The unique identifier of the task.
Type
The type of task:
CreateProtectionGroup
RemoveProtectionGroup
FailOver
FailOverTest
StopFailOverTest
Move
ProtectVM
UnprotectVM
AddVMToProtectionGroup
RemoveVMFromProtectionGroup
 
InstallVra
UninstallVra
GetVMSettings
UpdateProtectionGroup
InsertTaggedCP
WaitForCP
HandleMirrorPromotion
ActivateAllMirrors
LogCollection
ClearCheckpoints
ForceReconfigurationOfNewVM
ClearSite
ForceRemoveProtectionGroup
ForceUpdateProtectionGroup
ForceKillProtectionGroup
 
PrePostScript
InitFullSync
Pair
Unpair
AddPeerVraInfo
RemovePeerVraInfo
InstallCloudConnector
UninstallCloudConnector
HandleFirstSyncDone
 
Clone
MoveBeforeCommit
MoveRollback
MoveCommit
MaintainHost
NotSupportedInThisVersion
MoveProtectionGroupToManualOperationNeeded
 
FailoverBeforeCommit
FailoverCommit
FailoverRollback
ChangeVraIpSettings
PauseProtectionGroup
ResumeProtectionGroup
BulkUpgradeVras
BulkUninstallVras
ChangeVraPassword
ChangeRecoveryHost
ChangeRecoveryHostForProtectionGroup
 
VpgBackup
RedeployCloudConnectorCleanup
RestoreVpg
VpgDeleteBackup
SubmitSupportTicket
PreScript
PostScript
ChangeVraPasswordIpSettings
FlrJournalMount
FlrJournalUnmount
Login
Response values for https://zvm_ip:port/v1/tasks/types.
Response – Description
Task types:
CreateProtectionGroup
RemoveProtectionGroup
FailOver
FailOverTest
StopFailOverTest
Move
ProtectVM
UnprotectVM
AddVMToProtectionGroup
RemoveVMFromProtectionGroup
InstallVra
UninstallVra
GetVMSettings
UpdateProtectionGroup
InsertTaggedCP
WaitForCP
HandleMirrorPromotion
ActivateAllMirrors
LogCollection
ClearCheckpoints
ForceReconfigurationOfNewVM
ClearSite
ForceRemoveProtectionGroup
ForceUpdateProtectionGroup
ForceKillProtectionGroup
PrePostScript
InitFullSync
Pair
Unpair
AddPeerVraInfo
RemovePeerVraInfo
InstallCloudConnector
UninstallCloudConnector
HandleFirstSyncDone
Clone
MoveBeforeCommit
MoveRollback
MoveCommit
MaintainHost
NotSupportedInThisVersion
MoveProtectionGroupToManualOperationNeeded
FailoverBeforeCommit
FailoverCommit
FailoverRollback
ChangeVraIpSettings
PauseProtectionGroup
ResumeProtectionGroup
BulkUpgradeVras
BulkUninstallVras
ChangeVraPassword
ChangeRecoveryHost
ChangeRecoveryHostForProtectionGroup
VpgBackup
RedeployCloudConnectorCleanup
RestoreVpg
VpgDeleteBackup
SubmitSupportTicket
PreScript
PostScript
ChangeVraPasswordIpSettings
FlrJournalMount
FlrJournalUnmount
Login