IP address mapping rules - GET configuration

  • Reference
  • Published Sep 24, 2020

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

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/geographicRegions/ipAddressMappings
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/geographicRegions/ipAddressMappings

Authentication

To execute this request, you need an access token with ReadConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

The request doesn't provide any configurable parameters.

Response

Response codes

CodeTypeDescription
200IpAddressMappings

Success

Response body objects

The IpAddressMappings object

Configuration of the IP address mappings to geographic locations.

ElementTypeDescription
ipAddressMappingRulesIpAddressMappingRule[]

A list of IP address mapping rules.

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

The IpAddressMappingRule object

Configuration of the IP address mapping to the geographic location.

ElementTypeDescription
ipAddressMappingLocationIpAddressMappingLocation

The location for an IP address mapping.

ipAddressRangeIpAddressRange

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

The IpAddressMappingLocation object

The location for an IP address mapping.

ElementTypeDescription
citystring

The city name of the location.

countryCodestring

The country code of the location.

To fetch the list of available country codes, use the GET all countries request.

latitudenumber

The latitude of the location in DDD.dddd format.

longitudenumber

The longitude of the location in DDD.dddd format.

regionCodestring

The region code of the location.

To fetch the list of available region codes, use the GET regions of the country request.

The IpAddressRange object

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

ElementTypeDescription
addressstring

The IP address to be mapped.

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

addressTostring

The to address of the IP address range.

subnetMaskinteger

The subnet mask of the IP address range.

Response body JSON model

{
  "ipAddressMappingRules": [
    {
      "ipAddressMappingLocation": {
        "city": "string",
        "countryCode": "string",
        "latitude": 1,
        "longitude": 1,
        "regionCode": "string"
      },
      "ipAddressRange": {
        "address": "string",
        "addressTo": "string",
        "subnetMask": 1
      }
    }
  ]
}