load-balancing_location_strategy

Controls location-based steering for non-proxied requests. See `steering_policy` to learn how steering is affected.

APIs.ioEngineeringPlatform

Properties

Name Type Description
mode string Determines the authoritative location when ECS is not preferred, does not exist in the request, or its GeoIP lookup is unsuccessful. - `"pop"`: Use the Cloudflare PoP location. - `"resolver_ip"`: Use
prefer_ecs string Whether the EDNS Client Subnet (ECS) GeoIP should be preferred as the authoritative location. - `"always"`: Always prefer ECS. - `"never"`: Never prefer ECS. - `"proximity"`: Prefer ECS only when `ste
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-load-balancing-location-strategy-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/load-balancing_location_strategy",
  "title": "load-balancing_location_strategy",
  "description": "Controls location-based steering for non-proxied requests. See `steering_policy` to learn how steering is affected.",
  "properties": {
    "mode": {
      "default": "pop",
      "description": "Determines the authoritative location when ECS is not preferred, does not exist in the request, or its GeoIP lookup is unsuccessful.\n- `\"pop\"`: Use the Cloudflare PoP location.\n- `\"resolver_ip\"`: Use the DNS resolver GeoIP location. If the GeoIP lookup is unsuccessful, use the Cloudflare PoP location.",
      "enum": [
        "pop",
        "resolver_ip"
      ],
      "example": "resolver_ip",
      "type": "string"
    },
    "prefer_ecs": {
      "default": "proximity",
      "description": "Whether the EDNS Client Subnet (ECS) GeoIP should be preferred as the authoritative location.\n- `\"always\"`: Always prefer ECS.\n- `\"never\"`: Never prefer ECS.\n- `\"proximity\"`: Prefer ECS only when `steering_policy=\"proximity\"`.\n- `\"geo\"`: Prefer ECS only when `steering_policy=\"geo\"`.",
      "enum": [
        "always",
        "never",
        "proximity",
        "geo"
      ],
      "example": "always",
      "type": "string"
    }
  },
  "type": "object"
}