Perform an action like pause, resume, active, deactivate on all specified Protection Groups.

post

https://cluster.ip.address/v2/data-protect/protection-groups/states

Privileges: PROTECTION_JOB_OPERATE

Perform an action like pause, resume, active, deactivate on all specified Protection Groups. 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 Groups. 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 Groups state is changed successfully.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

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

action

string | null

enum

required

Specifies the action to be performed on all the specfied Protection Groups. 'kActivate' specifies that Protection Group should be activated. 'kDeactivate' sepcifies that Protection Group should be deactivated. 'kPause' specifies that Protection Group should be paused. 'kResume' specifies that Protection Group should be resumed.

Allowed:

ids

array of strings | null

required

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

ids*

lastPauseReason

string | null

enum

Specifies the reason why the protection group was paused

Allowed:

pausedNote

string | null

A note from the current user explaining the reason for pausing future runs, if applicable.

tenantId

string | null

Specifies the tenant id who has access to these protection groups.

200Success

defaultError