Get the list of Protection Groups.

get

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ids

array of strings

Filter by a list of Protection Group ids.

ids

names

array of strings

Filter by a list of Protection Group names.

names

policyIds

array of strings

Filter by Policy ids that are associated with Protection Groups. Only Protection Groups associated with the specified Policy ids, are returned.

policyIds

environments

array of strings

Filter by environment types such as 'kVMware', 'kView', etc. Only Protection Groups protecting the specified environment types are returned.

environments

isActive

boolean

Filter by Inactive or Active Protection Groups. If not set, all Inactive and Active Protection Groups are returned. If true, only Active Protection Groups are returned. If false, only Inactive Protection Groups are returned. When you create a Protection Group on a Primary Cluster with a replication schedule, the Cluster creates an Inactive copy of the Protection Group on the Remote Cluster. In addition, when an Active and running Protection Group is deactivated, the Protection Group becomes Inactive.

isDeleted

boolean

If true, return only Protection Groups that have been deleted but still have Snapshots associated with them. If false, return all Protection Groups except those Protection Groups that have been deleted and still have Snapshots associated with them. A Protection Group that is deleted with all its Snapshots is not returned for either of these cases.

isPaused

boolean

Filter by paused or non paused Protection Groups, If not set, all paused and non paused Protection Groups are returned. If true, only paused Protection Groups are returned. If false, only non paused Protection Groups are returned.

lastRunAnyStatus

array of strings

Filter by last any run status.
'Running' indicates that the run is still running.
'Canceled' indicates that the run has been canceled.
'Canceling' indicates that the run is in the process of being canceled.
'Failed' indicates that the run has failed.
'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening.
'Succeeded' indicates that the run has finished successfully.
'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Skipped' indicates that the run was skipped.

lastRunAnyStatus

isLastRunSlaViolated

boolean

If true, return Protection Groups for which last run SLA was violated.

includeLastRunInfo

boolean

If true, the response will include last run info. If it is false or not specified, the last run info won't be returned.

Responses

200Success

defaultError