List Protection Policies filtered by some parameters.

get

https://cluster.ip.address/irisservices/api/v1/public/protectionPolicies

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

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

origin

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:

tenantIds

array of strings

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

tenantIds

allUnderHierarchy

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

Loading…

Response

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

application/json

200Success

defaultError