List Protection Policies filtered by some parameters.

Privileges: PROTECTION_POLICY_VIEW

If no parameters are specified, all Protection Policies currently on the
Cohesity Cluster are returned.
Specifying parameters filters the results that are returned.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
ids
array of strings

Filter by a list of Protection Policy ids.

ids
names
array of strings

Filter by a list of Protection Policy names.

names
environments
array of strings

Filter by Environment type such as 'kVMware', 'kView', etc.
Only Policies protecting the specified environment type are returned.
NOTE: 'kPuppeteer' refers to Cohesity's Remote Adapter.

environments
vaultIds
array of int64s

Filter by a list of Vault ids. Policies archiving to any of the
specified vaults will be returned.

vaultIds
string
enum

Specifies the origin of the protection policy.
'kHelios' means a global policy which was created on Helios.
'kLocal' means a local policy which was created on the cluster.

Allowed:
types
array of strings

Specifies the type of the protection policy.
'kRegular' means a regular Protection Policy.
'kRPO' means an RPO Protection Policy.

types
Allowed:
boolean

Specifies whether to fetch replicated policies in addition to local
policies.

boolean

If true, includes the immutability field in the protection policy
response. Default is false.

string
enum

When set, the response additionally populates 'retentionPeriod'
sibling fields (typed as DurationInUnit, carrying both unit and
duration) on the policy and its copy / extended-retention
sub-policies. The requested unit (Days or Minutes) is echoed in each
populated DurationInUnit.Unit and the duration field on the same
DurationInUnit carries the re-expressed whole-number count in that
unit (DaysToKeep values multiplied by 1440 for Minutes; NumSecsToKeep
floored by 60 for Minutes and 86400 for Days).

The existing whole-number retention fields keep their original names
and units regardless of the requested unit:
DaysToKeep / DaysToKeepLog / DaysToKeepSystem stay in days, even
when Minutes was requested. They are not renamed and not
converted; they remain the source of truth.
NumSecsToKeep stays in seconds.
Only the new retentionPeriod sibling fields reflect the requested
unit. Each retentionPeriod is omitted per entry when its source
value is unset.

Default: omitted (retentionPeriod sibling fields absent).
DurationUnit specifies the time unit a Duration value is expressed in.
Used by APIs that report or accept a derived integer duration alongside
its unit, including schedule frequencies and retention durations on
protection-policy and protection-run responses (and by the matching
'durationUnit' query parameter that selects the unit those responses
should be expressed in).

Allowed:
tenantIds
array of strings

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

tenantIds
boolean

AllUnderHierarchy specifies if objects of all the tenants under the
hierarchy of the logged in user's organization should be returned.

Responses

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