Policy management API - DELETE a policy

  • Latest Dynatrace
  • Reference
  • Published Jul 25, 2022

Deletes an access policy. You can't delete a global-level policy, as these are managed by Dynatrace.

DELETE

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

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

ParameterTypeDescriptionInRequired
force-

Set to true to delete a policy that is still in use.

queryRequired
policyUuid-

The ID of the required policy.

pathRequired
levelId-

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

  • account: use the UUID of the account.
  • environment: use the ID of the environment.
pathRequired
levelType-

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

  • 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.

pathRequired

Response

Response codes

CodeTypeDescription
204-

Success. The policy has been deleted. The response doesn't have a body.

400ErrorDto

Failed. The request is invalid

404ErrorDto

Failed. The specified resource is not found.

Response body objects

The ErrorDto object

ElementTypeDescription
codenumber

The code of the error.

messagestring

A short description of the error.

errorsMapobject-

Response body JSON models

{
  "code": 1,
  "message": "string",
  "errorsMap": {}
}

Example

In this example, the request deletes the apiExample policy from the POST request example. The response code of 204 indicates successful deletion.

Curl

curl --request DELETE \
  --url https://api.dynatrace.com/iam/v1/repo/environment/lde68092/policies/0c621587-f978-4c7b-89ee-d2045f611b03 \
  --header 'Authorization: Bearer abcdefjhij1234567890'

Request URL

https://api.dynatrace.com/iam/v1/repo/environment/lde68092/policies/0c621587-f978-4c7b-89ee-d2045f611b03

Response code

204