Policy management API - GET native policies

Lists all policies that are native to a policy level.

The request produces an application/json payload.

GET

https://api.dynatrace.com/iam/v1/repo/{levelType}/{levelId}/policies

Authentication

To execute this request, you need the Allow IAM policy configuration for environments (iam-policies-management) permission assigned to your token. To learn how to obtain and use it, see OAuth clients.

Parameters

Parameter
Type
Description
In
Required
levelType
string

The type of the policy level. The following values are available:

  • global: A global policy applies to all accounts and environments. It is defined and managed by Dynatrace.
  • account: An account policy applies to all environments of an account.
  • environment: An environment policy applies to a specific environment.

Each level inherits the policies of the higher level and extends them with its own policies.

path
required
levelId
string

The ID of the policy level. Use one of the following values, depending on the level type:

  • global: use the global value.
  • account: use the UUID of the account.
  • environment: use the ID of the environment.
path
required
name
string

Optional policy name. Only policies that are of equal name will be returned.

query
optional
categories
string[]

Optional policy categories set. Only policies that match given categories will be returned.

query
optional

Response

Response codes

Code
Type
Description
200

Success. The response contains the list of policies.

404

Failed. The specified resource is not found.

Response body objects

The PolicyDtoList object

Element
Type
Description
policies

A list of policies.

The PolicyDto object

Element
Type
Description
uuid
string

The ID of the policy.

name
string

The display name of the policy.

description
string

A short description of the policy.

Response body JSON model

{
  "policies": [
    {
      "uuid": "string",
      "name": "string",
      "description": "string"
    }
  ]
}

Example

In this example, the request lists native policies of the mySampleEnv environment. The result is truncated to two entries.

Curl

curl --request GET \
  --url 'https://api.dynatrace.com/iam/v1/repo/environment/mySampleEnv/policies' \
  --header 'Authorization: Bearer abcdefjhij1234567890'

Request URL

https://api.dynatrace.com/iam/v1/repo/environment/mySampleEnv/policies

Response body

{
  "policies": [
    {
      "uuid": "b420b269-7acb-4081-b98f-b5772de63542",
      "name": "Settings Reader",
      "description": "Settings Reader Policy"
    },
    {
      "uuid": "d10eb8e0-875a-40c8-821c-6214c23ac0b3",
      "name": "Settings Writer",
      "description": "Settings Writer Policy"
    }
  ]
}

Response code

200