Common Geolocation Provider Configuration (proto)

Common geolocation provider configuration overview. Common configuration shared across geolocation providers.

extensions.geoip_providers.common.v3.CommonGeoipProviderConfig

[extensions.geoip_providers.common.v3.CommonGeoipProviderConfig proto]

{
  "geo_headers_to_add": {...},
  "geo_field_keys": {...}
}

geo_headers_to_add: (extensions.geoip_providers.common.v3.CommonGeoipProviderConfig.GeolocationHeadersToAdd) Configuration for geolocation headers to add to HTTP requests. This field is deprecated in favor of geo_field_keys. If both are set, geo_field_keys takes precedence.

geo_field_keys: (extensions.geoip_providers.common.v3.CommonGeoipProviderConfig.GeolocationFieldKeys) Configuration for geolocation field keys. At least one of geo_headers_to_add or geo_field_keys must be set.

extensions.geoip_providers.common.v3.CommonGeoipProviderConfig.GeolocationHeadersToAdd

[extensions.geoip_providers.common.v3.CommonGeoipProviderConfig.GeolocationHeadersToAdd proto]

The set of geolocation headers to add to request. If any of the configured headers is present in the incoming request, it will be overridden by the HTTP GeoIP filter.

Attention

This field is deprecated in favor of geo_field_keys.

{
  "country": ...,
  "city": ...,
  "region": ...,
  "asn": ...,
  "is_anon": ...,
  "anon": ...,
  "anon_vpn": ...,
  "anon_hosting": ...,
  "anon_tor": ...,
  "anon_proxy": ...,
  "isp": ...,
  "apple_private_relay": ...
}

country: (string) If set, the header will be used to populate the country ISO code associated with the IP address.

city: (string) If set, the header will be used to populate the city associated with the IP address.

region: (string) If set, the header will be used to populate the region ISO code associated with the IP address. The least specific subdivision will be selected as the region value.

asn: (string) If set, the header will be used to populate the ASN associated with the IP address.

is_anon: (string) This field is deprecated; use anon instead.

anon: (string) If set, the IP address will be checked if it belongs to any type of anonymization network (e.g., VPN, public proxy). The header will be populated with the check result. Header value will be set to either true or false depending on the check result.

anon_vpn: (string) If set, the IP address will be checked if it belongs to a VPN and the header will be populated with the check result. Header value will be set to either true or false depending on the check result.

anon_hosting: (string) If set, the IP address will be checked if it belongs to a hosting provider and the header will be populated with the check result. Header value will be set to either true or false depending on the check result.

anon_tor: (string) If set, the IP address will be checked if it belongs to a TOR exit node and the header will be populated with the check result. Header value will be set to either true or false depending on the check result.

anon_proxy: (string) If set, the IP address will be checked if it belongs to a public proxy and the header will be populated with the check result. Header value will be set to either true or false depending on the check result.

isp: (string) If set, the header will be used to populate the ISP associated with the IP address.

apple_private_relay: (string) If set, the IP address will be checked if it belongs to the ISP named iCloud Private Relay and the header will be populated with the check result. Header value will be set to either true or false depending on the check result.

extensions.geoip_providers.common.v3.CommonGeoipProviderConfig.GeolocationFieldKeys

[extensions.geoip_providers.common.v3.CommonGeoipProviderConfig.GeolocationFieldKeys proto]

The set of geolocation field keys to use for storing lookup results. These keys define how the geolocation lookup results will be stored. The actual storage mechanism depends on the filter using the provider:

The HTTP GeoIP filter stores results as HTTP request headers.
The Network GeoIP filter stores results in the connection’s filter state under the well-known key envoy.geoip.

{
  "country": ...,
  "city": ...,
  "region": ...,
  "asn": ...,
  "anon": ...,
  "anon_vpn": ...,
  "anon_hosting": ...,
  "anon_tor": ...,
  "anon_proxy": ...,
  "isp": ...,
  "apple_private_relay": ...
}

country: (string) If set, the key will be used to populate the country ISO code associated with the IP address.

city: (string) If set, the key will be used to populate the city associated with the IP address.

region: (string) If set, the key will be used to populate the region ISO code associated with the IP address. The least specific subdivision will be selected as the region value.

asn: (string) If set, the key will be used to populate the ASN associated with the IP address.

anon: (string) If set, the IP address will be checked if it belongs to any type of anonymization network (e.g., VPN, public proxy). The result will be stored with this key. Value will be set to either true or false depending on the check result.

anon_vpn: (string) If set, the IP address will be checked if it belongs to a VPN and the result will be stored with this key. Value will be set to either true or false depending on the check result.

anon_hosting: (string) If set, the IP address will be checked if it belongs to a hosting provider and the result will be stored with this key. Value will be set to either true or false depending on the check result.

anon_tor: (string) If set, the IP address will be checked if it belongs to a TOR exit node and the result will be stored with this key. Value will be set to either true or false depending on the check result.

anon_proxy: (string) If set, the IP address will be checked if it belongs to a public proxy and the result will be stored with this key. Value will be set to either true or false depending on the check result.

isp: (string) If set, the key will be used to populate the ISP associated with the IP address.

apple_private_relay: (string) If set, the IP address will be checked if it belongs to the ISP named iCloud Private Relay and the result will be stored with this key. Value will be set to either true or false depending on the check result.