Cancel a Protection Job run.

post

https://cluster.ip.address/irisservices/api/v1/public/protectionRuns/cancel/{id}

Privileges: PROTECTION_JOB_OPERATE

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

Specifies a unique id of the Protection Job.

Body Params

copyTaskUid

object | null

CopyTaskUid is the Uid of a copy task. If a particular copy task is to be
cancelled, this field should be set to the id of that particular copy task.
For example, if replication task is to be canceled, CopyTaskUid of the
replication task has to be specified.

jobRunId

int64 | null

Run Id of a Protection Job Run that needs to be cancelled. If this Run
id does not match the id of an active Run in the Protection job, the job
Run is not cancelled and an error will be
returned.

taskIdList

array of int64s | null

List of entity ids for which we need to cancel the backup tasks. If this
is provided it will not cancel the complete run but will cancel only
subset of backup tasks (if backup tasks are cancelled correspoding copy
task will also get cancelled). If the backup tasks are completed
successfully it will not cancel those backup tasks.

taskIdList

Responses

204

No Content

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

defaultError