Getting StartedAPI ReferenceRecipesGitHub
API Reference

List Protection Policies based on provided filtering parameters.

get
https://cluster.ip.address/v2/data-protect/policies

Privileges: PROTECTION_POLICY_VIEW

Lists protection policies based on filtering query parameters.

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

Filter policies by a list of policy ids.

ids
policyNames
array of strings

Filter policies by a list of policy names.

policyNames
tenantIds
array of strings

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

tenantIds
boolean

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

types
array of strings
Defaults to Regular

Types specifies the policy type of policies to be returned

types
boolean

If excludeLinkedPolicies is set to true then only local policies created on cluster will be returned. The result will exclude all linked policies created from policy templates.

boolean

If includeReplicatedPolicies is set to true, then response will also contain replicated policies. By default, replication policies are not included in the response.

boolean

If includeStats is set to true, then response will return number of protection groups and objects. By default, the protection stats are not included in the response.

vaultIds
array of int64s

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

vaultIds
Headers
string
enum

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

Allowed:
Responses

Updated 3 months ago

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

Updated 3 months ago