Getting StartedAPI ReferenceRecipesGitHub
API Reference

Perform an action like pause, resume, activate, deactivate on all the specified Protection Jobs.

post
https://cluster.ip.address/irisservices/api/v1/public/protectionJobs/states

Privileges: PROTECTION_JOB_OPERATE

Note that the pause or resume actions will take effect from next Protection
Run. Also, user can specify only one type of action on all the Protection Jobs.
Deactivate and activate actions are independent of pause and resume state.
Deactivate and activate actions are useful in case of failover situations.

Returns success if the state of all the Protection Jobs state is changed
successfully.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Specifies the parameters to perform an action of list of Protection Jobs.

string | null
enum

Specifies the action to be performed on all the specified Protection Jobs.
Specifies the type of action to be performed on Protection Job.
'kActivate' specifies that Protection Job should be activated.
'kDeactivate' specifies that Protection Job should be deactivated.
'kPause' specifies that Protection Job should be paused.
'kResume' specifies that Protection Job should be resumed.

Allowed:
jobIds
array of int64s | null

Specifies a list of Protection Job ids for which the state should change.

jobIds
Responses

Updated about 5 hours ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 5 hours ago

Did this page help you?