Immediately execute a single Protection Job Run.

post

https://cluster.ip.address/irisservices/api/v1/public/protectionJobs/run/{id}

Privileges: PROTECTION_JOB_OPERATE

Immediately execute a single Job Run and ignore the schedule defined
in the Policy.
A Protection Policy associated with the Job may define up to three
backup run types:

Regular (CBT utilized), 2) Full (CBT not utilized) and 3) Log.
The passed in run type defines what type of backup is done by the Job Run.
The schedule defined in the Policy for the backup run type is ignored but
other settings such as the snapshot retention and retry settings are used.
Returns success if the Job Run starts.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

Specifies a unique id of the Protection Job.

Body Params

Specifies the type of backup. If not specified, the 'kRegular'
backup is run.

Specify the parameters to run a protection job.

copyRunTargets

array of objects | null

Optional parameter to be set if you want specific replication or archival
associated with the policy to run.

copyRunTargets

runNowParameters

array of objects | null

Optional parameters of a Run Now operation.

runNowParameters

runType

string | null

enum

Specifies the type of backup. If not specified, 'kRegular' is assumed.
'kRegular' indicates a incremental (CBT) backup. Incremental backups
utilizing CBT (if supported) are captured of the target protection objects.
The first run of a kRegular schedule captures all the blocks.
'kFull' indicates a full (no CBT) backup. A complete backup
(all blocks) of the target protection objects are always captured and
Change Block Tracking (CBT) is not utilized.
'kLog' indicates a Database Log backup. Capture the database
transaction logs to allow rolling back to a specific point in time.
'kSystem' indicates a system backup. System backups are used to do
bare metal recovery of the system to a specific point in time.

Allowed:

sourceIds

array of int64s | null

Optional parameter if you want to back up only a subset of sources that
are protected by the job in this run. If a Run Now operation is to be
performed then the source ids should only be provided in the
runNowParameters along with the database Ids.

sourceIds

usePolicyDefaults

boolean | null

Specifies if default policy settings should be used interanally to
copy snapshots to external targets already configured in policy. This
field will only apply if "CopyRunTargets" is empty.

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