IP address mapping rules - GET configuration
Gets the configuration of mapping between IP addresses and geographic regions.
The request produces an application/json
payload.
GET |
|
Authentication
To execute this request, you need the Read configuration (ReadConfig
) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Parameters
The request doesn't provide any configurable parameters.
Response
Response codes
Code | Description |
---|---|
200 | Success |
Response body
The IpAddressMappings object
Configuration of the IP address mappings to geographic locations.
Element | Type | Description |
---|---|---|
ipAddressMappingRules | IpAddressMappingRule[] | 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.
Element | Type | Description |
---|---|---|
ipAddressMappingLocation | IpAddressMappingLocation | |
ipAddressRange | IpAddressRange |
The IpAddressRange object
The IP address or the IP address range to be mapped to the location.
Element | Type | Description |
---|---|---|
subnetMask | integer | The subnet mask of the IP address range. |
address | string | The IP address to be mapped. For an IP address range, this is the from address. |
addressTo | string | The to address of the IP address range. |
The IpAddressMappingLocation object
The location for an IP address mapping.
Element | Type | Description |
---|---|---|
countryCode | string | The country code of the location. Use the alpha-2 code of the ISO 3166-2 standard, (for example, |
city | string | The city name of the location. |
regionCode | string | The region code of the location. For the USA or Canada use ISO 3166-2 state codes without For the rest of the world use FIPS 10-4 codes without country prefix. |
latitude | number | The latitude of the location in |
longitude | number | The longitude of the location in |
{
"ipAddressMappingRules": [
{
"ipAddressMappingLocation": {
"countryCode": "string",
"city": "string",
"regionCode": "string",
"latitude": "number",
"longitude": "number"
},
"ipAddressRange": {
"subnetMask": 0,
"address": "string",
"addressTo": "string"
}
}
]
}