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

post

https://helios.cohesity.com/v2/data-protect/protection-groups/states

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. [Internal/JPMC-only] This field is mandatory only if the iris backend feature flag (FLAGS_MakePausedNoteMandatory) is enabled. For JPMC, both the backend gflag (FLAGS_MakePausedNoteMandatory) and the UI feature flag (pauseNoteForceEnabled) must be enabled for this field to be mandatory. For all other customers, the field remains optional and the feature flag is not enabled by default. If any customer wants this feature, they must contact support for enablement.

tenantId

string | null

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

Headers

accessClusterId

int64

This field uniquely represents a Cohesity Cluster and is used for making on-prem calls from Helios.

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

200Success

defaultError