Try it free

IP address mapping rules - PUT configuration

  • Reference

Deprecated

This API endpoint is deprecated. Use the Map IP addresses to locations schema instead.

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

The request consumes an application/json payload.

PUTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/geographicRegions/ipAddressMappings
PUTEnvironment 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 WriteConfig scope.

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

Parameters

ParameterTypeDescriptionInRequired
bodyIpAddressMappings

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

bodyOptional

Request body objects

The IpAddressMappings object

Configuration of the IP address mappings to geographic locations.

ElementTypeDescriptionRequired
ipAddressMappingRulesIpAddressMappingRule[]

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.

ElementTypeDescriptionRequired
ipAddressMappingLocationIpAddressMappingLocation

The location for an IP address mapping.

Required
ipAddressRangeIpAddressRange

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

Required

The IpAddressMappingLocation object

The location for an IP address mapping.

ElementTypeDescriptionRequired
citystring

The city name of the location.

Optional
countryCodestring

The country code of the location.

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

Required
latitudenumber

The latitude of the location in DDD.dddd format.

Optional
longitudenumber

The longitude of the location in DDD.dddd format.

Optional
regionCodestring

The region code of the location.

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

Optional

The IpAddressRange object

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

ElementTypeDescriptionRequired
addressstring

The IP address to be mapped.

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

Required
addressTostring

The to address of the IP address range.

Optional
subnetMaskinteger

The subnet mask of the IP address range.

Optional

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.

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

Response

Response codes

CodeTypeDescription
204-

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

400ErrorEnvelope

Failed. The input is invalid

Response body objects

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

Response body JSON models

{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}

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.

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

Authentication

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

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

Response

Response codes

CodeTypeDescription
204-

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

400ErrorEnvelope

Failed. The input is invalid

Response body objects

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

Response body JSON models

{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}

Related topics

  • Map internal IP addresses to locations for web applications in RUM Classic
  • Map internal IP addresses to locations for mobile applications in RUM Classic
  • Map internal IP addresses to locations for custom applications in RUM Classic