Environment management API - PUT IP allowlist configuration

Preview Latest Dynatrace

Creates an IP allowlist configuration for a specific environment.

The request produces an application/json payload.

GET	`https://api.dynatrace.com/env/v1/accounts/environments/{environmentUuid}/ip-allowlist`

Authentication

To execute this request, you need the Allow read access for environment resources (account-env-read) scope assigned to your token. To learn how to obtain and use it, see Authentication.

Parameters

Parameter	Type	Description	In	Required
accountUuid	string	-	path	required
environmentUuid	string	-	path	required
body	IpConfigDto	The body of the request. Contains the key and serialized value for setting a ip config for a specific tenant on a specific cluster.	body	required

Request body objects

The `IpConfigDto` object

Element	Type	Description	Required
enabled	boolean	If enabled the ip config allow list gets applied.	required
allowlist	AllowlistItem[]	Contains a list of valid IP addresses in CIDR format which are allowed. If enabled it must not be empty.	optional

The `AllowlistItem` object

Element	Type	Description	Required
name	string	The name of the list.	required
ipRange	string	One ip address or the range of ip addresses. Supports the CIDR format.	required

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
  "enabled": true,
  "allowlist": [
    {
      "name": "Some IP-range",
      "ipRange": "10.0.0.0/32"
    }
  ]
}

Response

Response codes

Code	Description
201	Success. The IP configuration has been successfully set.