Get the list of Protection Groups.

get

https://cluster.ip.address/v2/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

storageDomainId

int64

Filter by Storage Domain id. Only Protection Groups writing data to this Storage Domain will be returned.

includeGroupsWithDatalockOnly

boolean

Whether to only return Protection Groups with a datalock.

environments

array of strings

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

environments

office365Workloads

array of strings

office365Workloads

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.

lastRunLocalBackupStatus

array of strings

Filter by last local backup 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.
'Paused' indicates that the ongoing run has been paused.

lastRunLocalBackupStatus

lastRunReplicationStatus

array of strings

Filter by last remote replication 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.
'Paused' indicates that the ongoing run has been paused.

lastRunReplicationStatus

lastRunArchivalStatus

array of strings

Filter by last cloud archival 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.
'Paused' indicates that the ongoing run has been paused.

lastRunArchivalStatus

lastRunCloudSpinStatus

array of strings

Filter by last cloud spin 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.
'Paused' indicates that the ongoing run has been paused.

lastRunCloudSpinStatus

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.
'Paused' indicates that the ongoing run has been paused.

lastRunAnyStatus

isLastRunSlaViolated

boolean

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

tenantIds

array of strings

TenantIds contains ids of the tenants for which objects are to be returned.

tenantIds

includeTenants

boolean

If true, the response will include Protection Groups which were created by all tenants which the current user has permission to see. If false, then only Protection Groups created by the current user will be returned.

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.

pruneExcludedSourceIds

boolean

If true, the response will not include the list of excluded source IDs in groups that contain this field. This can be set to true in order to improve performance if excluded source IDs are not needed by the user.

pruneSourceIds

boolean

If true, the response will exclude the list of source IDs within the group specified.

useCachedData

boolean

Specifies whether we can serve the GET request from the read replica cache. There is a lag of 15 seconds between the read replica and primary data source.

Headers

requestInitiatorType

string

enum

Specifies the type of request from UI, which is used for services like magneto to determine the priority of requests.

Allowed:

Responses

200Success

defaultError