IP address mapping rules - PUT configuration

Updates the configuration of mapping between IP addresses and geographic regions.

The request consumes an application/json payload.

PUT
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/geographicRegions/ipAddressMappings
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/geographicRegions/ipAddressMappings
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/geographicRegions/ipAddressMappings

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter Type Description In Required
body IpAddressMappings

The JSON body of the request. Contains the configuration of the IP address mapping.

body optional

Body format

The IpAddressMappings object

Configuration of the IP address mappings to geographic locations.

Element Type Description Required
ipAddressMappingRules IpAddressMappingRule[]

A list of IP address mapping rules.

Rules are evaluated from top to bottom; the first matching rule applies.

optional

The IpAddressMappingRule object

Configuration of the IP address mapping to the geographic location.

Element Type Description Required
ipAddressMappingLocation IpAddressMappingLocation required
ipAddressRange IpAddressRange required

The IpAddressRange object

The IP address or the IP address range to be mapped to the location.

Element Type Description Required
subnetMask integer

The subnet mask of the IP address range.

optional
address string

The IP address to be mapped.

For an IP address range, this is the from address.

required
addressTo string

The to address of the IP address range.

optional

The IpAddressMappingLocation object

The location for an IP address mapping.

Element Type Description Required
countryCode string

The country code of the location.

Use the alpha-2 code of the ISO 3166-2 standard, (for example, AT for Austria or PL for Poland).

required
city string

The city name of the location.

optional
regionCode string

The region code of the location.

For the USA or Canada use ISO 3166-2 state codes without US- or CA- prefix.

For the rest of the world use FIPS 10-4 codes without country prefix.

optional
latitude number

The latitude of the location in DDD.dddd format.

optional
longitude number

The longitude of the location in DDD.dddd format.

optional

Response

Response codes

Code Description
204

Success. The configuration has been updated. Response doesn't have a body.

400

Failed. The input is invalid

Response body

A successful request doesn't return any content.

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/geographicRegions/ipAddressMappings/validator
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/geographicRegions/ipAddressMappings/validator
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/geographicRegions/ipAddressMappings/validator

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

Code Description
204

Success. The submitted configuration is valid. Response doesn't have a body.

400

Failed. The input is invalid

Response body

A successful request doesn't return any content.