# Load Balancers

## List Load Balancers

`load_balancers.list(LoadBalancerListParams**kwargs)  -> SyncSinglePage[LoadBalancer]`

**get** `/zones/{zone_id}/load_balancers`

List configured load balancers.

### Parameters

- `zone_id: str`

### Returns

- `class LoadBalancer: …`

  - `id: Optional[str]`

  - `adaptive_routing: Optional[AdaptiveRouting]`

    Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.

    - `failover_across_pools: Optional[bool]`

      Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See `session_affinity_attributes` for control over when sessions are broken or reassigned.

  - `country_pools: Optional[Dict[str, List[str]]]`

    A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools.

  - `created_on: Optional[str]`

  - `default_pools: Optional[List[DefaultPools]]`

    A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.

  - `description: Optional[str]`

    Object description.

  - `enabled: Optional[bool]`

    Whether to enable (the default) this load balancer.

  - `fallback_pool: Optional[str]`

    The pool ID to use when all other pools are detected as unhealthy.

  - `location_strategy: Optional[LocationStrategy]`

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

    - `mode: Optional[Literal["pop", "resolver_ip"]]`

      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 the DNS resolver GeoIP location. If the GeoIP lookup is unsuccessful, use the Cloudflare PoP location.

      - `"pop"`

      - `"resolver_ip"`

    - `prefer_ecs: Optional[Literal["always", "never", "proximity", "geo"]]`

      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 `steering_policy="proximity"`.
      - `"geo"`: Prefer ECS only when `steering_policy="geo"`.

      - `"always"`

      - `"never"`

      - `"proximity"`

      - `"geo"`

  - `modified_on: Optional[str]`

  - `name: Optional[str]`

    The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.

  - `networks: Optional[List[str]]`

    List of networks where Load Balancer or Pool is enabled.

  - `pop_pools: Optional[Dict[str, List[str]]]`

    Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.

  - `proxied: Optional[bool]`

    Whether the hostname should be gray clouded (false) or orange clouded (true).

  - `random_steering: Optional[RandomSteering]`

    Configures pool weights.

    - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights.
    - `steering_policy="least_outstanding_requests"`: Use pool weights to scale each pool's outstanding requests.
    - `steering_policy="least_connections"`: Use pool weights to scale each pool's open connections.

    - `default_weight: Optional[float]`

      The default weight for pools in the load balancer that are not specified in the pool_weights map.

    - `pool_weights: Optional[Dict[str, float]]`

      A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.

  - `region_pools: Optional[Dict[str, List[str]]]`

    A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.

  - `rules: Optional[List[Rules]]`

    BETA Field Not General Access: A list of rules for this load balancer to execute.

    - `condition: Optional[str]`

      The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions.

    - `disabled: Optional[bool]`

      Disable this specific rule. It will no longer be evaluated by this load balancer.

    - `fixed_response: Optional[FixedResponse]`

      A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed_response is supplied the rule will be marked as terminates.

      - `content_type: Optional[str]`

        The http 'Content-Type' header to include in the response.

      - `location: Optional[str]`

        The http 'Location' header to include in the response.

      - `message_body: Optional[str]`

        Text to include as the http body.

      - `status_code: Optional[int]`

        The http status code to respond with.

    - `name: Optional[str]`

      Name of this rule. Only used for human readability.

    - `overrides: Optional[Overrides]`

      A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional.

      - `adaptive_routing: Optional[AdaptiveRouting]`

        Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.

      - `country_pools: Optional[Dict[str, List[str]]]`

        A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools.

      - `default_pools: Optional[List[DefaultPools]]`

        A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.

      - `fallback_pool: Optional[str]`

        The pool ID to use when all other pools are detected as unhealthy.

      - `location_strategy: Optional[LocationStrategy]`

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

      - `pop_pools: Optional[Dict[str, List[str]]]`

        Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.

      - `random_steering: Optional[RandomSteering]`

        Configures pool weights.

        - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights.
        - `steering_policy="least_outstanding_requests"`: Use pool weights to scale each pool's outstanding requests.
        - `steering_policy="least_connections"`: Use pool weights to scale each pool's open connections.

      - `region_pools: Optional[Dict[str, List[str]]]`

        A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.

      - `session_affinity: Optional[SessionAffinity]`

        Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ip_cookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `session_affinity_ttl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `session_affinity_attributes` for additional required configuration.

        - `"none"`

        - `"cookie"`

        - `"ip_cookie"`

        - `"header"`

      - `session_affinity_attributes: Optional[SessionAffinityAttributes]`

        Configures attributes for session affinity.

        - `drain_duration: Optional[float]`

          Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.

        - `headers: Optional[List[str]]`

          Configures the names of HTTP headers to base session affinity on when header `session_affinity` is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: `"cookie:<cookie-name-1>,<cookie-name-2>"` (example) where everything after the colon is a comma-separated list of cookie names. Providing only `"cookie"` will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.

        - `require_all_headers: Optional[bool]`

          When header `session_affinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are: - `"true"`: Load balancing requests must contain *all* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created. - `"false"`: Load balancing requests must contain *at least one* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created.

        - `samesite: Optional[Literal["Auto", "Lax", "None", "Strict"]]`

          Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never".

          - `"Auto"`

          - `"Lax"`

          - `"None"`

          - `"Strict"`

        - `secure: Optional[Literal["Auto", "Always", "Never"]]`

          Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled.

          - `"Auto"`

          - `"Always"`

          - `"Never"`

        - `zero_downtime_failover: Optional[Literal["none", "temporary", "sticky"]]`

          Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are: - `"none"`: No failover takes place for sessions pinned to the origin (default). - `"temporary"`: Traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping. - `"sticky"`: The session affinity cookie is updated and subsequent requests are sent to the new origin. Note: Zero-downtime failover with sticky sessions is currently not supported for session affinity by header.

          - `"none"`

          - `"temporary"`

          - `"sticky"`

      - `session_affinity_ttl: Optional[float]`

        Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `session_affinity` policy are: - `"cookie"` / `"ip_cookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.

      - `steering_policy: Optional[SteeringPolicy]`

        Steering Policy for this load balancer.

        - `"off"`: Use `default_pools`.
        - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.
        - `"random"`: Select a pool randomly.
        - `"dynamic_latency"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).
        - `"proximity"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.
        - `"least_outstanding_requests"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of outstanding requests. Pools with more pending requests are weighted proportionately less relative to others.
        - `"least_connections"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of open connections. Pools with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.
        - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`.

        - `"off"`

        - `"geo"`

        - `"random"`

        - `"dynamic_latency"`

        - `"proximity"`

        - `"least_outstanding_requests"`

        - `"least_connections"`

        - `""`

      - `ttl: Optional[float]`

        Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

    - `priority: Optional[int]`

      The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority.

    - `terminates: Optional[bool]`

      If this rule's condition is true, this causes rule evaluation to stop after processing this rule.

  - `session_affinity: Optional[SessionAffinity]`

    Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ip_cookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `session_affinity_ttl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `session_affinity_attributes` for additional required configuration.

  - `session_affinity_attributes: Optional[SessionAffinityAttributes]`

    Configures attributes for session affinity.

  - `session_affinity_ttl: Optional[float]`

    Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `session_affinity` policy are: - `"cookie"` / `"ip_cookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.

  - `steering_policy: Optional[SteeringPolicy]`

    Steering Policy for this load balancer.

    - `"off"`: Use `default_pools`.
    - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.
    - `"random"`: Select a pool randomly.
    - `"dynamic_latency"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).
    - `"proximity"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.
    - `"least_outstanding_requests"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of outstanding requests. Pools with more pending requests are weighted proportionately less relative to others.
    - `"least_connections"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of open connections. Pools with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.
    - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`.

  - `ttl: Optional[float]`

    Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

  - `zone_name: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
page = client.load_balancers.list(
    zone_id="699d98642c564d2e855e9661899b7252",
)
page = page.result[0]
print(page.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "699d98642c564d2e855e9661899b7252",
      "adaptive_routing": {
        "failover_across_pools": true
      },
      "country_pools": {
        "GB": [
          "abd90f38ced07c2e2f4df50b1f61d4194"
        ],
        "US": [
          "de90f38ced07c2e2f4df50b1f61d4194",
          "00920f38ce07c2e2f4df50b1f61d4194"
        ]
      },
      "created_on": "2014-01-01T05:20:00.12345Z",
      "default_pools": [
        "17b5962d775c646f3f9725cbc7a53df4",
        "9290f38c5d07c2e2f4df57b1f61d4196",
        "00920f38ce07c2e2f4df50b1f61d4194"
      ],
      "description": "Load Balancer for www.example.com",
      "enabled": true,
      "fallback_pool": "fallback_pool",
      "location_strategy": {
        "mode": "resolver_ip",
        "prefer_ecs": "always"
      },
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "name": "www.example.com",
      "networks": [
        "string"
      ],
      "pop_pools": {
        "LAX": [
          "de90f38ced07c2e2f4df50b1f61d4194",
          "9290f38c5d07c2e2f4df57b1f61d4196"
        ],
        "LHR": [
          "abd90f38ced07c2e2f4df50b1f61d4194",
          "f9138c5d07c2e2f4df57b1f61d4196"
        ],
        "SJC": [
          "00920f38ce07c2e2f4df50b1f61d4194"
        ]
      },
      "proxied": true,
      "random_steering": {
        "default_weight": 0.2,
        "pool_weights": {
          "9290f38c5d07c2e2f4df57b1f61d4196": 0.5,
          "de90f38ced07c2e2f4df50b1f61d4194": 0.3
        }
      },
      "region_pools": {
        "ENAM": [
          "00920f38ce07c2e2f4df50b1f61d4194"
        ],
        "WNAM": [
          "de90f38ced07c2e2f4df50b1f61d4194",
          "9290f38c5d07c2e2f4df57b1f61d4196"
        ]
      },
      "rules": [
        {
          "condition": "http.request.uri.path contains \"/testing\"",
          "disabled": true,
          "fixed_response": {
            "content_type": "application/json",
            "location": "www.example.com",
            "message_body": "Testing Hello",
            "status_code": 0
          },
          "name": "route the path /testing to testing datacenter.",
          "overrides": {
            "adaptive_routing": {
              "failover_across_pools": true
            },
            "country_pools": {
              "GB": [
                "abd90f38ced07c2e2f4df50b1f61d4194"
              ],
              "US": [
                "de90f38ced07c2e2f4df50b1f61d4194",
                "00920f38ce07c2e2f4df50b1f61d4194"
              ]
            },
            "default_pools": [
              "17b5962d775c646f3f9725cbc7a53df4",
              "9290f38c5d07c2e2f4df57b1f61d4196",
              "00920f38ce07c2e2f4df50b1f61d4194"
            ],
            "fallback_pool": "fallback_pool",
            "location_strategy": {
              "mode": "resolver_ip",
              "prefer_ecs": "always"
            },
            "pop_pools": {
              "LAX": [
                "de90f38ced07c2e2f4df50b1f61d4194",
                "9290f38c5d07c2e2f4df57b1f61d4196"
              ],
              "LHR": [
                "abd90f38ced07c2e2f4df50b1f61d4194",
                "f9138c5d07c2e2f4df57b1f61d4196"
              ],
              "SJC": [
                "00920f38ce07c2e2f4df50b1f61d4194"
              ]
            },
            "random_steering": {
              "default_weight": 0.2,
              "pool_weights": {
                "9290f38c5d07c2e2f4df57b1f61d4196": 0.5,
                "de90f38ced07c2e2f4df50b1f61d4194": 0.3
              }
            },
            "region_pools": {
              "ENAM": [
                "00920f38ce07c2e2f4df50b1f61d4194"
              ],
              "WNAM": [
                "de90f38ced07c2e2f4df50b1f61d4194",
                "9290f38c5d07c2e2f4df57b1f61d4196"
              ]
            },
            "session_affinity": "cookie",
            "session_affinity_attributes": {
              "drain_duration": 100,
              "headers": [
                "x"
              ],
              "require_all_headers": true,
              "samesite": "Auto",
              "secure": "Auto",
              "zero_downtime_failover": "sticky"
            },
            "session_affinity_ttl": 1800,
            "steering_policy": "dynamic_latency",
            "ttl": 30
          },
          "priority": 0,
          "terminates": true
        }
      ],
      "session_affinity": "cookie",
      "session_affinity_attributes": {
        "drain_duration": 100,
        "headers": [
          "x"
        ],
        "require_all_headers": true,
        "samesite": "Auto",
        "secure": "Auto",
        "zero_downtime_failover": "sticky"
      },
      "session_affinity_ttl": 1800,
      "steering_policy": "dynamic_latency",
      "ttl": 30,
      "zone_name": "example.com"
    }
  ],
  "success": true,
  "result_info": {
    "count": 20,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}
```

## Load Balancer Details

`load_balancers.get(strload_balancer_id, LoadBalancerGetParams**kwargs)  -> LoadBalancer`

**get** `/zones/{zone_id}/load_balancers/{load_balancer_id}`

Fetch a single configured load balancer.

### Parameters

- `zone_id: str`

- `load_balancer_id: str`

### Returns

- `class LoadBalancer: …`

  - `id: Optional[str]`

  - `adaptive_routing: Optional[AdaptiveRouting]`

    Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.

    - `failover_across_pools: Optional[bool]`

      Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See `session_affinity_attributes` for control over when sessions are broken or reassigned.

  - `country_pools: Optional[Dict[str, List[str]]]`

    A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools.

  - `created_on: Optional[str]`

  - `default_pools: Optional[List[DefaultPools]]`

    A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.

  - `description: Optional[str]`

    Object description.

  - `enabled: Optional[bool]`

    Whether to enable (the default) this load balancer.

  - `fallback_pool: Optional[str]`

    The pool ID to use when all other pools are detected as unhealthy.

  - `location_strategy: Optional[LocationStrategy]`

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

    - `mode: Optional[Literal["pop", "resolver_ip"]]`

      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 the DNS resolver GeoIP location. If the GeoIP lookup is unsuccessful, use the Cloudflare PoP location.

      - `"pop"`

      - `"resolver_ip"`

    - `prefer_ecs: Optional[Literal["always", "never", "proximity", "geo"]]`

      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 `steering_policy="proximity"`.
      - `"geo"`: Prefer ECS only when `steering_policy="geo"`.

      - `"always"`

      - `"never"`

      - `"proximity"`

      - `"geo"`

  - `modified_on: Optional[str]`

  - `name: Optional[str]`

    The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.

  - `networks: Optional[List[str]]`

    List of networks where Load Balancer or Pool is enabled.

  - `pop_pools: Optional[Dict[str, List[str]]]`

    Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.

  - `proxied: Optional[bool]`

    Whether the hostname should be gray clouded (false) or orange clouded (true).

  - `random_steering: Optional[RandomSteering]`

    Configures pool weights.

    - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights.
    - `steering_policy="least_outstanding_requests"`: Use pool weights to scale each pool's outstanding requests.
    - `steering_policy="least_connections"`: Use pool weights to scale each pool's open connections.

    - `default_weight: Optional[float]`

      The default weight for pools in the load balancer that are not specified in the pool_weights map.

    - `pool_weights: Optional[Dict[str, float]]`

      A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.

  - `region_pools: Optional[Dict[str, List[str]]]`

    A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.

  - `rules: Optional[List[Rules]]`

    BETA Field Not General Access: A list of rules for this load balancer to execute.

    - `condition: Optional[str]`

      The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions.

    - `disabled: Optional[bool]`

      Disable this specific rule. It will no longer be evaluated by this load balancer.

    - `fixed_response: Optional[FixedResponse]`

      A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed_response is supplied the rule will be marked as terminates.

      - `content_type: Optional[str]`

        The http 'Content-Type' header to include in the response.

      - `location: Optional[str]`

        The http 'Location' header to include in the response.

      - `message_body: Optional[str]`

        Text to include as the http body.

      - `status_code: Optional[int]`

        The http status code to respond with.

    - `name: Optional[str]`

      Name of this rule. Only used for human readability.

    - `overrides: Optional[Overrides]`

      A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional.

      - `adaptive_routing: Optional[AdaptiveRouting]`

        Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.

      - `country_pools: Optional[Dict[str, List[str]]]`

        A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools.

      - `default_pools: Optional[List[DefaultPools]]`

        A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.

      - `fallback_pool: Optional[str]`

        The pool ID to use when all other pools are detected as unhealthy.

      - `location_strategy: Optional[LocationStrategy]`

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

      - `pop_pools: Optional[Dict[str, List[str]]]`

        Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.

      - `random_steering: Optional[RandomSteering]`

        Configures pool weights.

        - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights.
        - `steering_policy="least_outstanding_requests"`: Use pool weights to scale each pool's outstanding requests.
        - `steering_policy="least_connections"`: Use pool weights to scale each pool's open connections.

      - `region_pools: Optional[Dict[str, List[str]]]`

        A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.

      - `session_affinity: Optional[SessionAffinity]`

        Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ip_cookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `session_affinity_ttl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `session_affinity_attributes` for additional required configuration.

        - `"none"`

        - `"cookie"`

        - `"ip_cookie"`

        - `"header"`

      - `session_affinity_attributes: Optional[SessionAffinityAttributes]`

        Configures attributes for session affinity.

        - `drain_duration: Optional[float]`

          Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.

        - `headers: Optional[List[str]]`

          Configures the names of HTTP headers to base session affinity on when header `session_affinity` is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: `"cookie:<cookie-name-1>,<cookie-name-2>"` (example) where everything after the colon is a comma-separated list of cookie names. Providing only `"cookie"` will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.

        - `require_all_headers: Optional[bool]`

          When header `session_affinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are: - `"true"`: Load balancing requests must contain *all* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created. - `"false"`: Load balancing requests must contain *at least one* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created.

        - `samesite: Optional[Literal["Auto", "Lax", "None", "Strict"]]`

          Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never".

          - `"Auto"`

          - `"Lax"`

          - `"None"`

          - `"Strict"`

        - `secure: Optional[Literal["Auto", "Always", "Never"]]`

          Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled.

          - `"Auto"`

          - `"Always"`

          - `"Never"`

        - `zero_downtime_failover: Optional[Literal["none", "temporary", "sticky"]]`

          Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are: - `"none"`: No failover takes place for sessions pinned to the origin (default). - `"temporary"`: Traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping. - `"sticky"`: The session affinity cookie is updated and subsequent requests are sent to the new origin. Note: Zero-downtime failover with sticky sessions is currently not supported for session affinity by header.

          - `"none"`

          - `"temporary"`

          - `"sticky"`

      - `session_affinity_ttl: Optional[float]`

        Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `session_affinity` policy are: - `"cookie"` / `"ip_cookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.

      - `steering_policy: Optional[SteeringPolicy]`

        Steering Policy for this load balancer.

        - `"off"`: Use `default_pools`.
        - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.
        - `"random"`: Select a pool randomly.
        - `"dynamic_latency"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).
        - `"proximity"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.
        - `"least_outstanding_requests"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of outstanding requests. Pools with more pending requests are weighted proportionately less relative to others.
        - `"least_connections"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of open connections. Pools with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.
        - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`.

        - `"off"`

        - `"geo"`

        - `"random"`

        - `"dynamic_latency"`

        - `"proximity"`

        - `"least_outstanding_requests"`

        - `"least_connections"`

        - `""`

      - `ttl: Optional[float]`

        Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

    - `priority: Optional[int]`

      The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority.

    - `terminates: Optional[bool]`

      If this rule's condition is true, this causes rule evaluation to stop after processing this rule.

  - `session_affinity: Optional[SessionAffinity]`

    Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ip_cookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `session_affinity_ttl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `session_affinity_attributes` for additional required configuration.

  - `session_affinity_attributes: Optional[SessionAffinityAttributes]`

    Configures attributes for session affinity.

  - `session_affinity_ttl: Optional[float]`

    Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `session_affinity` policy are: - `"cookie"` / `"ip_cookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.

  - `steering_policy: Optional[SteeringPolicy]`

    Steering Policy for this load balancer.

    - `"off"`: Use `default_pools`.
    - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.
    - `"random"`: Select a pool randomly.
    - `"dynamic_latency"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).
    - `"proximity"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.
    - `"least_outstanding_requests"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of outstanding requests. Pools with more pending requests are weighted proportionately less relative to others.
    - `"least_connections"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of open connections. Pools with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.
    - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`.

  - `ttl: Optional[float]`

    Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

  - `zone_name: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
load_balancer = client.load_balancers.get(
    load_balancer_id="699d98642c564d2e855e9661899b7252",
    zone_id="699d98642c564d2e855e9661899b7252",
)
print(load_balancer.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "699d98642c564d2e855e9661899b7252",
    "adaptive_routing": {
      "failover_across_pools": true
    },
    "country_pools": {
      "GB": [
        "abd90f38ced07c2e2f4df50b1f61d4194"
      ],
      "US": [
        "de90f38ced07c2e2f4df50b1f61d4194",
        "00920f38ce07c2e2f4df50b1f61d4194"
      ]
    },
    "created_on": "2014-01-01T05:20:00.12345Z",
    "default_pools": [
      "17b5962d775c646f3f9725cbc7a53df4",
      "9290f38c5d07c2e2f4df57b1f61d4196",
      "00920f38ce07c2e2f4df50b1f61d4194"
    ],
    "description": "Load Balancer for www.example.com",
    "enabled": true,
    "fallback_pool": "fallback_pool",
    "location_strategy": {
      "mode": "resolver_ip",
      "prefer_ecs": "always"
    },
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "www.example.com",
    "networks": [
      "string"
    ],
    "pop_pools": {
      "LAX": [
        "de90f38ced07c2e2f4df50b1f61d4194",
        "9290f38c5d07c2e2f4df57b1f61d4196"
      ],
      "LHR": [
        "abd90f38ced07c2e2f4df50b1f61d4194",
        "f9138c5d07c2e2f4df57b1f61d4196"
      ],
      "SJC": [
        "00920f38ce07c2e2f4df50b1f61d4194"
      ]
    },
    "proxied": true,
    "random_steering": {
      "default_weight": 0.2,
      "pool_weights": {
        "9290f38c5d07c2e2f4df57b1f61d4196": 0.5,
        "de90f38ced07c2e2f4df50b1f61d4194": 0.3
      }
    },
    "region_pools": {
      "ENAM": [
        "00920f38ce07c2e2f4df50b1f61d4194"
      ],
      "WNAM": [
        "de90f38ced07c2e2f4df50b1f61d4194",
        "9290f38c5d07c2e2f4df57b1f61d4196"
      ]
    },
    "rules": [
      {
        "condition": "http.request.uri.path contains \"/testing\"",
        "disabled": true,
        "fixed_response": {
          "content_type": "application/json",
          "location": "www.example.com",
          "message_body": "Testing Hello",
          "status_code": 0
        },
        "name": "route the path /testing to testing datacenter.",
        "overrides": {
          "adaptive_routing": {
            "failover_across_pools": true
          },
          "country_pools": {
            "GB": [
              "abd90f38ced07c2e2f4df50b1f61d4194"
            ],
            "US": [
              "de90f38ced07c2e2f4df50b1f61d4194",
              "00920f38ce07c2e2f4df50b1f61d4194"
            ]
          },
          "default_pools": [
            "17b5962d775c646f3f9725cbc7a53df4",
            "9290f38c5d07c2e2f4df57b1f61d4196",
            "00920f38ce07c2e2f4df50b1f61d4194"
          ],
          "fallback_pool": "fallback_pool",
          "location_strategy": {
            "mode": "resolver_ip",
            "prefer_ecs": "always"
          },
          "pop_pools": {
            "LAX": [
              "de90f38ced07c2e2f4df50b1f61d4194",
              "9290f38c5d07c2e2f4df57b1f61d4196"
            ],
            "LHR": [
              "abd90f38ced07c2e2f4df50b1f61d4194",
              "f9138c5d07c2e2f4df57b1f61d4196"
            ],
            "SJC": [
              "00920f38ce07c2e2f4df50b1f61d4194"
            ]
          },
          "random_steering": {
            "default_weight": 0.2,
            "pool_weights": {
              "9290f38c5d07c2e2f4df57b1f61d4196": 0.5,
              "de90f38ced07c2e2f4df50b1f61d4194": 0.3
            }
          },
          "region_pools": {
            "ENAM": [
              "00920f38ce07c2e2f4df50b1f61d4194"
            ],
            "WNAM": [
              "de90f38ced07c2e2f4df50b1f61d4194",
              "9290f38c5d07c2e2f4df57b1f61d4196"
            ]
          },
          "session_affinity": "cookie",
          "session_affinity_attributes": {
            "drain_duration": 100,
            "headers": [
              "x"
            ],
            "require_all_headers": true,
            "samesite": "Auto",
            "secure": "Auto",
            "zero_downtime_failover": "sticky"
          },
          "session_affinity_ttl": 1800,
          "steering_policy": "dynamic_latency",
          "ttl": 30
        },
        "priority": 0,
        "terminates": true
      }
    ],
    "session_affinity": "cookie",
    "session_affinity_attributes": {
      "drain_duration": 100,
      "headers": [
        "x"
      ],
      "require_all_headers": true,
      "samesite": "Auto",
      "secure": "Auto",
      "zero_downtime_failover": "sticky"
    },
    "session_affinity_ttl": 1800,
    "steering_policy": "dynamic_latency",
    "ttl": 30,
    "zone_name": "example.com"
  },
  "success": true
}
```

## Create Load Balancer

`load_balancers.create(LoadBalancerCreateParams**kwargs)  -> LoadBalancer`

**post** `/zones/{zone_id}/load_balancers`

Create a new load balancer.

### Parameters

- `zone_id: str`

- `default_pools: SequenceNotStr[DefaultPools]`

  A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.

- `fallback_pool: str`

  The pool ID to use when all other pools are detected as unhealthy.

- `name: str`

  The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.

- `adaptive_routing: Optional[AdaptiveRoutingParam]`

  Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.

  - `failover_across_pools: Optional[bool]`

    Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See `session_affinity_attributes` for control over when sessions are broken or reassigned.

- `country_pools: Optional[Dict[str, SequenceNotStr[str]]]`

  A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools.

- `description: Optional[str]`

  Object description.

- `location_strategy: Optional[LocationStrategyParam]`

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

  - `mode: Optional[Literal["pop", "resolver_ip"]]`

    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 the DNS resolver GeoIP location. If the GeoIP lookup is unsuccessful, use the Cloudflare PoP location.

    - `"pop"`

    - `"resolver_ip"`

  - `prefer_ecs: Optional[Literal["always", "never", "proximity", "geo"]]`

    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 `steering_policy="proximity"`.
    - `"geo"`: Prefer ECS only when `steering_policy="geo"`.

    - `"always"`

    - `"never"`

    - `"proximity"`

    - `"geo"`

- `networks: Optional[SequenceNotStr[str]]`

  List of networks where Load Balancer or Pool is enabled.

- `pop_pools: Optional[Dict[str, SequenceNotStr[str]]]`

  Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.

- `proxied: Optional[bool]`

  Whether the hostname should be gray clouded (false) or orange clouded (true).

- `random_steering: Optional[RandomSteeringParam]`

  Configures pool weights.

  - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights.
  - `steering_policy="least_outstanding_requests"`: Use pool weights to scale each pool's outstanding requests.
  - `steering_policy="least_connections"`: Use pool weights to scale each pool's open connections.

  - `default_weight: Optional[float]`

    The default weight for pools in the load balancer that are not specified in the pool_weights map.

  - `pool_weights: Optional[Dict[str, float]]`

    A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.

- `region_pools: Optional[Dict[str, SequenceNotStr[str]]]`

  A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.

- `rules: Optional[Iterable[RulesParam]]`

  BETA Field Not General Access: A list of rules for this load balancer to execute.

  - `condition: Optional[str]`

    The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions.

  - `disabled: Optional[bool]`

    Disable this specific rule. It will no longer be evaluated by this load balancer.

  - `fixed_response: Optional[FixedResponse]`

    A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed_response is supplied the rule will be marked as terminates.

    - `content_type: Optional[str]`

      The http 'Content-Type' header to include in the response.

    - `location: Optional[str]`

      The http 'Location' header to include in the response.

    - `message_body: Optional[str]`

      Text to include as the http body.

    - `status_code: Optional[int]`

      The http status code to respond with.

  - `name: Optional[str]`

    Name of this rule. Only used for human readability.

  - `overrides: Optional[Overrides]`

    A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional.

    - `adaptive_routing: Optional[AdaptiveRouting]`

      Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.

    - `country_pools: Optional[Dict[str, List[str]]]`

      A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools.

    - `default_pools: Optional[List[DefaultPools]]`

      A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.

    - `fallback_pool: Optional[str]`

      The pool ID to use when all other pools are detected as unhealthy.

    - `location_strategy: Optional[LocationStrategy]`

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

    - `pop_pools: Optional[Dict[str, List[str]]]`

      Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.

    - `random_steering: Optional[RandomSteering]`

      Configures pool weights.

      - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights.
      - `steering_policy="least_outstanding_requests"`: Use pool weights to scale each pool's outstanding requests.
      - `steering_policy="least_connections"`: Use pool weights to scale each pool's open connections.

    - `region_pools: Optional[Dict[str, List[str]]]`

      A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.

    - `session_affinity: Optional[SessionAffinity]`

      Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ip_cookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `session_affinity_ttl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `session_affinity_attributes` for additional required configuration.

      - `"none"`

      - `"cookie"`

      - `"ip_cookie"`

      - `"header"`

    - `session_affinity_attributes: Optional[SessionAffinityAttributes]`

      Configures attributes for session affinity.

      - `drain_duration: Optional[float]`

        Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.

      - `headers: Optional[List[str]]`

        Configures the names of HTTP headers to base session affinity on when header `session_affinity` is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: `"cookie:<cookie-name-1>,<cookie-name-2>"` (example) where everything after the colon is a comma-separated list of cookie names. Providing only `"cookie"` will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.

      - `require_all_headers: Optional[bool]`

        When header `session_affinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are: - `"true"`: Load balancing requests must contain *all* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created. - `"false"`: Load balancing requests must contain *at least one* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created.

      - `samesite: Optional[Literal["Auto", "Lax", "None", "Strict"]]`

        Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never".

        - `"Auto"`

        - `"Lax"`

        - `"None"`

        - `"Strict"`

      - `secure: Optional[Literal["Auto", "Always", "Never"]]`

        Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled.

        - `"Auto"`

        - `"Always"`

        - `"Never"`

      - `zero_downtime_failover: Optional[Literal["none", "temporary", "sticky"]]`

        Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are: - `"none"`: No failover takes place for sessions pinned to the origin (default). - `"temporary"`: Traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping. - `"sticky"`: The session affinity cookie is updated and subsequent requests are sent to the new origin. Note: Zero-downtime failover with sticky sessions is currently not supported for session affinity by header.

        - `"none"`

        - `"temporary"`

        - `"sticky"`

    - `session_affinity_ttl: Optional[float]`

      Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `session_affinity` policy are: - `"cookie"` / `"ip_cookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.

    - `steering_policy: Optional[SteeringPolicy]`

      Steering Policy for this load balancer.

      - `"off"`: Use `default_pools`.
      - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.
      - `"random"`: Select a pool randomly.
      - `"dynamic_latency"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).
      - `"proximity"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.
      - `"least_outstanding_requests"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of outstanding requests. Pools with more pending requests are weighted proportionately less relative to others.
      - `"least_connections"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of open connections. Pools with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.
      - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`.

      - `"off"`

      - `"geo"`

      - `"random"`

      - `"dynamic_latency"`

      - `"proximity"`

      - `"least_outstanding_requests"`

      - `"least_connections"`

      - `""`

    - `ttl: Optional[float]`

      Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

  - `priority: Optional[int]`

    The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority.

  - `terminates: Optional[bool]`

    If this rule's condition is true, this causes rule evaluation to stop after processing this rule.

- `session_affinity: Optional[SessionAffinity]`

  Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ip_cookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `session_affinity_ttl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `session_affinity_attributes` for additional required configuration.

- `session_affinity_attributes: Optional[SessionAffinityAttributesParam]`

  Configures attributes for session affinity.

- `session_affinity_ttl: Optional[float]`

  Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `session_affinity` policy are: - `"cookie"` / `"ip_cookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.

- `steering_policy: Optional[SteeringPolicy]`

  Steering Policy for this load balancer.

  - `"off"`: Use `default_pools`.
  - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.
  - `"random"`: Select a pool randomly.
  - `"dynamic_latency"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).
  - `"proximity"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.
  - `"least_outstanding_requests"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of outstanding requests. Pools with more pending requests are weighted proportionately less relative to others.
  - `"least_connections"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of open connections. Pools with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.
  - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`.

- `ttl: Optional[float]`

  Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

### Returns

- `class LoadBalancer: …`

  - `id: Optional[str]`

  - `adaptive_routing: Optional[AdaptiveRouting]`

    Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.

    - `failover_across_pools: Optional[bool]`

      Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See `session_affinity_attributes` for control over when sessions are broken or reassigned.

  - `country_pools: Optional[Dict[str, List[str]]]`

    A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools.

  - `created_on: Optional[str]`

  - `default_pools: Optional[List[DefaultPools]]`

    A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.

  - `description: Optional[str]`

    Object description.

  - `enabled: Optional[bool]`

    Whether to enable (the default) this load balancer.

  - `fallback_pool: Optional[str]`

    The pool ID to use when all other pools are detected as unhealthy.

  - `location_strategy: Optional[LocationStrategy]`

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

    - `mode: Optional[Literal["pop", "resolver_ip"]]`

      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 the DNS resolver GeoIP location. If the GeoIP lookup is unsuccessful, use the Cloudflare PoP location.

      - `"pop"`

      - `"resolver_ip"`

    - `prefer_ecs: Optional[Literal["always", "never", "proximity", "geo"]]`

      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 `steering_policy="proximity"`.
      - `"geo"`: Prefer ECS only when `steering_policy="geo"`.

      - `"always"`

      - `"never"`

      - `"proximity"`

      - `"geo"`

  - `modified_on: Optional[str]`

  - `name: Optional[str]`

    The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.

  - `networks: Optional[List[str]]`

    List of networks where Load Balancer or Pool is enabled.

  - `pop_pools: Optional[Dict[str, List[str]]]`

    Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.

  - `proxied: Optional[bool]`

    Whether the hostname should be gray clouded (false) or orange clouded (true).

  - `random_steering: Optional[RandomSteering]`

    Configures pool weights.

    - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights.
    - `steering_policy="least_outstanding_requests"`: Use pool weights to scale each pool's outstanding requests.
    - `steering_policy="least_connections"`: Use pool weights to scale each pool's open connections.

    - `default_weight: Optional[float]`

      The default weight for pools in the load balancer that are not specified in the pool_weights map.

    - `pool_weights: Optional[Dict[str, float]]`

      A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.

  - `region_pools: Optional[Dict[str, List[str]]]`

    A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.

  - `rules: Optional[List[Rules]]`

    BETA Field Not General Access: A list of rules for this load balancer to execute.

    - `condition: Optional[str]`

      The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions.

    - `disabled: Optional[bool]`

      Disable this specific rule. It will no longer be evaluated by this load balancer.

    - `fixed_response: Optional[FixedResponse]`

      A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed_response is supplied the rule will be marked as terminates.

      - `content_type: Optional[str]`

        The http 'Content-Type' header to include in the response.

      - `location: Optional[str]`

        The http 'Location' header to include in the response.

      - `message_body: Optional[str]`

        Text to include as the http body.

      - `status_code: Optional[int]`

        The http status code to respond with.

    - `name: Optional[str]`

      Name of this rule. Only used for human readability.

    - `overrides: Optional[Overrides]`

      A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional.

      - `adaptive_routing: Optional[AdaptiveRouting]`

        Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.

      - `country_pools: Optional[Dict[str, List[str]]]`

        A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools.

      - `default_pools: Optional[List[DefaultPools]]`

        A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.

      - `fallback_pool: Optional[str]`

        The pool ID to use when all other pools are detected as unhealthy.

      - `location_strategy: Optional[LocationStrategy]`

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

      - `pop_pools: Optional[Dict[str, List[str]]]`

        Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.

      - `random_steering: Optional[RandomSteering]`

        Configures pool weights.

        - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights.
        - `steering_policy="least_outstanding_requests"`: Use pool weights to scale each pool's outstanding requests.
        - `steering_policy="least_connections"`: Use pool weights to scale each pool's open connections.

      - `region_pools: Optional[Dict[str, List[str]]]`

        A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.

      - `session_affinity: Optional[SessionAffinity]`

        Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ip_cookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `session_affinity_ttl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `session_affinity_attributes` for additional required configuration.

        - `"none"`

        - `"cookie"`

        - `"ip_cookie"`

        - `"header"`

      - `session_affinity_attributes: Optional[SessionAffinityAttributes]`

        Configures attributes for session affinity.

        - `drain_duration: Optional[float]`

          Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.

        - `headers: Optional[List[str]]`

          Configures the names of HTTP headers to base session affinity on when header `session_affinity` is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: `"cookie:<cookie-name-1>,<cookie-name-2>"` (example) where everything after the colon is a comma-separated list of cookie names. Providing only `"cookie"` will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.

        - `require_all_headers: Optional[bool]`

          When header `session_affinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are: - `"true"`: Load balancing requests must contain *all* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created. - `"false"`: Load balancing requests must contain *at least one* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created.

        - `samesite: Optional[Literal["Auto", "Lax", "None", "Strict"]]`

          Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never".

          - `"Auto"`

          - `"Lax"`

          - `"None"`

          - `"Strict"`

        - `secure: Optional[Literal["Auto", "Always", "Never"]]`

          Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled.

          - `"Auto"`

          - `"Always"`

          - `"Never"`

        - `zero_downtime_failover: Optional[Literal["none", "temporary", "sticky"]]`

          Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are: - `"none"`: No failover takes place for sessions pinned to the origin (default). - `"temporary"`: Traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping. - `"sticky"`: The session affinity cookie is updated and subsequent requests are sent to the new origin. Note: Zero-downtime failover with sticky sessions is currently not supported for session affinity by header.

          - `"none"`

          - `"temporary"`

          - `"sticky"`

      - `session_affinity_ttl: Optional[float]`

        Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `session_affinity` policy are: - `"cookie"` / `"ip_cookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.

      - `steering_policy: Optional[SteeringPolicy]`

        Steering Policy for this load balancer.

        - `"off"`: Use `default_pools`.
        - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.
        - `"random"`: Select a pool randomly.
        - `"dynamic_latency"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).
        - `"proximity"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.
        - `"least_outstanding_requests"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of outstanding requests. Pools with more pending requests are weighted proportionately less relative to others.
        - `"least_connections"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of open connections. Pools with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.
        - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`.

        - `"off"`

        - `"geo"`

        - `"random"`

        - `"dynamic_latency"`

        - `"proximity"`

        - `"least_outstanding_requests"`

        - `"least_connections"`

        - `""`

      - `ttl: Optional[float]`

        Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

    - `priority: Optional[int]`

      The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority.

    - `terminates: Optional[bool]`

      If this rule's condition is true, this causes rule evaluation to stop after processing this rule.

  - `session_affinity: Optional[SessionAffinity]`

    Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ip_cookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `session_affinity_ttl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `session_affinity_attributes` for additional required configuration.

  - `session_affinity_attributes: Optional[SessionAffinityAttributes]`

    Configures attributes for session affinity.

  - `session_affinity_ttl: Optional[float]`

    Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `session_affinity` policy are: - `"cookie"` / `"ip_cookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.

  - `steering_policy: Optional[SteeringPolicy]`

    Steering Policy for this load balancer.

    - `"off"`: Use `default_pools`.
    - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.
    - `"random"`: Select a pool randomly.
    - `"dynamic_latency"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).
    - `"proximity"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.
    - `"least_outstanding_requests"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of outstanding requests. Pools with more pending requests are weighted proportionately less relative to others.
    - `"least_connections"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of open connections. Pools with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.
    - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`.

  - `ttl: Optional[float]`

    Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

  - `zone_name: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
load_balancer = client.load_balancers.create(
    zone_id="699d98642c564d2e855e9661899b7252",
    default_pools=["17b5962d775c646f3f9725cbc7a53df4", "9290f38c5d07c2e2f4df57b1f61d4196", "00920f38ce07c2e2f4df50b1f61d4194"],
    fallback_pool="fallback_pool",
    name="www.example.com",
)
print(load_balancer.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "699d98642c564d2e855e9661899b7252",
    "adaptive_routing": {
      "failover_across_pools": true
    },
    "country_pools": {
      "GB": [
        "abd90f38ced07c2e2f4df50b1f61d4194"
      ],
      "US": [
        "de90f38ced07c2e2f4df50b1f61d4194",
        "00920f38ce07c2e2f4df50b1f61d4194"
      ]
    },
    "created_on": "2014-01-01T05:20:00.12345Z",
    "default_pools": [
      "17b5962d775c646f3f9725cbc7a53df4",
      "9290f38c5d07c2e2f4df57b1f61d4196",
      "00920f38ce07c2e2f4df50b1f61d4194"
    ],
    "description": "Load Balancer for www.example.com",
    "enabled": true,
    "fallback_pool": "fallback_pool",
    "location_strategy": {
      "mode": "resolver_ip",
      "prefer_ecs": "always"
    },
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "www.example.com",
    "networks": [
      "string"
    ],
    "pop_pools": {
      "LAX": [
        "de90f38ced07c2e2f4df50b1f61d4194",
        "9290f38c5d07c2e2f4df57b1f61d4196"
      ],
      "LHR": [
        "abd90f38ced07c2e2f4df50b1f61d4194",
        "f9138c5d07c2e2f4df57b1f61d4196"
      ],
      "SJC": [
        "00920f38ce07c2e2f4df50b1f61d4194"
      ]
    },
    "proxied": true,
    "random_steering": {
      "default_weight": 0.2,
      "pool_weights": {
        "9290f38c5d07c2e2f4df57b1f61d4196": 0.5,
        "de90f38ced07c2e2f4df50b1f61d4194": 0.3
      }
    },
    "region_pools": {
      "ENAM": [
        "00920f38ce07c2e2f4df50b1f61d4194"
      ],
      "WNAM": [
        "de90f38ced07c2e2f4df50b1f61d4194",
        "9290f38c5d07c2e2f4df57b1f61d4196"
      ]
    },
    "rules": [
      {
        "condition": "http.request.uri.path contains \"/testing\"",
        "disabled": true,
        "fixed_response": {
          "content_type": "application/json",
          "location": "www.example.com",
          "message_body": "Testing Hello",
          "status_code": 0
        },
        "name": "route the path /testing to testing datacenter.",
        "overrides": {
          "adaptive_routing": {
            "failover_across_pools": true
          },
          "country_pools": {
            "GB": [
              "abd90f38ced07c2e2f4df50b1f61d4194"
            ],
            "US": [
              "de90f38ced07c2e2f4df50b1f61d4194",
              "00920f38ce07c2e2f4df50b1f61d4194"
            ]
          },
          "default_pools": [
            "17b5962d775c646f3f9725cbc7a53df4",
            "9290f38c5d07c2e2f4df57b1f61d4196",
            "00920f38ce07c2e2f4df50b1f61d4194"
          ],
          "fallback_pool": "fallback_pool",
          "location_strategy": {
            "mode": "resolver_ip",
            "prefer_ecs": "always"
          },
          "pop_pools": {
            "LAX": [
              "de90f38ced07c2e2f4df50b1f61d4194",
              "9290f38c5d07c2e2f4df57b1f61d4196"
            ],
            "LHR": [
              "abd90f38ced07c2e2f4df50b1f61d4194",
              "f9138c5d07c2e2f4df57b1f61d4196"
            ],
            "SJC": [
              "00920f38ce07c2e2f4df50b1f61d4194"
            ]
          },
          "random_steering": {
            "default_weight": 0.2,
            "pool_weights": {
              "9290f38c5d07c2e2f4df57b1f61d4196": 0.5,
              "de90f38ced07c2e2f4df50b1f61d4194": 0.3
            }
          },
          "region_pools": {
            "ENAM": [
              "00920f38ce07c2e2f4df50b1f61d4194"
            ],
            "WNAM": [
              "de90f38ced07c2e2f4df50b1f61d4194",
              "9290f38c5d07c2e2f4df57b1f61d4196"
            ]
          },
          "session_affinity": "cookie",
          "session_affinity_attributes": {
            "drain_duration": 100,
            "headers": [
              "x"
            ],
            "require_all_headers": true,
            "samesite": "Auto",
            "secure": "Auto",
            "zero_downtime_failover": "sticky"
          },
          "session_affinity_ttl": 1800,
          "steering_policy": "dynamic_latency",
          "ttl": 30
        },
        "priority": 0,
        "terminates": true
      }
    ],
    "session_affinity": "cookie",
    "session_affinity_attributes": {
      "drain_duration": 100,
      "headers": [
        "x"
      ],
      "require_all_headers": true,
      "samesite": "Auto",
      "secure": "Auto",
      "zero_downtime_failover": "sticky"
    },
    "session_affinity_ttl": 1800,
    "steering_policy": "dynamic_latency",
    "ttl": 30,
    "zone_name": "example.com"
  },
  "success": true
}
```

## Update Load Balancer

`load_balancers.update(strload_balancer_id, LoadBalancerUpdateParams**kwargs)  -> LoadBalancer`

**put** `/zones/{zone_id}/load_balancers/{load_balancer_id}`

Update a configured load balancer.

### Parameters

- `zone_id: str`

- `load_balancer_id: str`

- `default_pools: SequenceNotStr[DefaultPools]`

  A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.

- `fallback_pool: str`

  The pool ID to use when all other pools are detected as unhealthy.

- `name: str`

  The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.

- `adaptive_routing: Optional[AdaptiveRoutingParam]`

  Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.

  - `failover_across_pools: Optional[bool]`

    Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See `session_affinity_attributes` for control over when sessions are broken or reassigned.

- `country_pools: Optional[Dict[str, SequenceNotStr[str]]]`

  A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools.

- `description: Optional[str]`

  Object description.

- `enabled: Optional[bool]`

  Whether to enable (the default) this load balancer.

- `location_strategy: Optional[LocationStrategyParam]`

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

  - `mode: Optional[Literal["pop", "resolver_ip"]]`

    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 the DNS resolver GeoIP location. If the GeoIP lookup is unsuccessful, use the Cloudflare PoP location.

    - `"pop"`

    - `"resolver_ip"`

  - `prefer_ecs: Optional[Literal["always", "never", "proximity", "geo"]]`

    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 `steering_policy="proximity"`.
    - `"geo"`: Prefer ECS only when `steering_policy="geo"`.

    - `"always"`

    - `"never"`

    - `"proximity"`

    - `"geo"`

- `networks: Optional[SequenceNotStr[str]]`

  List of networks where Load Balancer or Pool is enabled.

- `pop_pools: Optional[Dict[str, SequenceNotStr[str]]]`

  Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.

- `proxied: Optional[bool]`

  Whether the hostname should be gray clouded (false) or orange clouded (true).

- `random_steering: Optional[RandomSteeringParam]`

  Configures pool weights.

  - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights.
  - `steering_policy="least_outstanding_requests"`: Use pool weights to scale each pool's outstanding requests.
  - `steering_policy="least_connections"`: Use pool weights to scale each pool's open connections.

  - `default_weight: Optional[float]`

    The default weight for pools in the load balancer that are not specified in the pool_weights map.

  - `pool_weights: Optional[Dict[str, float]]`

    A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.

- `region_pools: Optional[Dict[str, SequenceNotStr[str]]]`

  A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.

- `rules: Optional[Iterable[RulesParam]]`

  BETA Field Not General Access: A list of rules for this load balancer to execute.

  - `condition: Optional[str]`

    The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions.

  - `disabled: Optional[bool]`

    Disable this specific rule. It will no longer be evaluated by this load balancer.

  - `fixed_response: Optional[FixedResponse]`

    A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed_response is supplied the rule will be marked as terminates.

    - `content_type: Optional[str]`

      The http 'Content-Type' header to include in the response.

    - `location: Optional[str]`

      The http 'Location' header to include in the response.

    - `message_body: Optional[str]`

      Text to include as the http body.

    - `status_code: Optional[int]`

      The http status code to respond with.

  - `name: Optional[str]`

    Name of this rule. Only used for human readability.

  - `overrides: Optional[Overrides]`

    A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional.

    - `adaptive_routing: Optional[AdaptiveRouting]`

      Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.

    - `country_pools: Optional[Dict[str, List[str]]]`

      A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools.

    - `default_pools: Optional[List[DefaultPools]]`

      A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.

    - `fallback_pool: Optional[str]`

      The pool ID to use when all other pools are detected as unhealthy.

    - `location_strategy: Optional[LocationStrategy]`

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

    - `pop_pools: Optional[Dict[str, List[str]]]`

      Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.

    - `random_steering: Optional[RandomSteering]`

      Configures pool weights.

      - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights.
      - `steering_policy="least_outstanding_requests"`: Use pool weights to scale each pool's outstanding requests.
      - `steering_policy="least_connections"`: Use pool weights to scale each pool's open connections.

    - `region_pools: Optional[Dict[str, List[str]]]`

      A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.

    - `session_affinity: Optional[SessionAffinity]`

      Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ip_cookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `session_affinity_ttl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `session_affinity_attributes` for additional required configuration.

      - `"none"`

      - `"cookie"`

      - `"ip_cookie"`

      - `"header"`

    - `session_affinity_attributes: Optional[SessionAffinityAttributes]`

      Configures attributes for session affinity.

      - `drain_duration: Optional[float]`

        Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.

      - `headers: Optional[List[str]]`

        Configures the names of HTTP headers to base session affinity on when header `session_affinity` is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: `"cookie:<cookie-name-1>,<cookie-name-2>"` (example) where everything after the colon is a comma-separated list of cookie names. Providing only `"cookie"` will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.

      - `require_all_headers: Optional[bool]`

        When header `session_affinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are: - `"true"`: Load balancing requests must contain *all* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created. - `"false"`: Load balancing requests must contain *at least one* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created.

      - `samesite: Optional[Literal["Auto", "Lax", "None", "Strict"]]`

        Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never".

        - `"Auto"`

        - `"Lax"`

        - `"None"`

        - `"Strict"`

      - `secure: Optional[Literal["Auto", "Always", "Never"]]`

        Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled.

        - `"Auto"`

        - `"Always"`

        - `"Never"`

      - `zero_downtime_failover: Optional[Literal["none", "temporary", "sticky"]]`

        Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are: - `"none"`: No failover takes place for sessions pinned to the origin (default). - `"temporary"`: Traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping. - `"sticky"`: The session affinity cookie is updated and subsequent requests are sent to the new origin. Note: Zero-downtime failover with sticky sessions is currently not supported for session affinity by header.

        - `"none"`

        - `"temporary"`

        - `"sticky"`

    - `session_affinity_ttl: Optional[float]`

      Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `session_affinity` policy are: - `"cookie"` / `"ip_cookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.

    - `steering_policy: Optional[SteeringPolicy]`

      Steering Policy for this load balancer.

      - `"off"`: Use `default_pools`.
      - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.
      - `"random"`: Select a pool randomly.
      - `"dynamic_latency"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).
      - `"proximity"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.
      - `"least_outstanding_requests"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of outstanding requests. Pools with more pending requests are weighted proportionately less relative to others.
      - `"least_connections"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of open connections. Pools with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.
      - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`.

      - `"off"`

      - `"geo"`

      - `"random"`

      - `"dynamic_latency"`

      - `"proximity"`

      - `"least_outstanding_requests"`

      - `"least_connections"`

      - `""`

    - `ttl: Optional[float]`

      Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

  - `priority: Optional[int]`

    The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority.

  - `terminates: Optional[bool]`

    If this rule's condition is true, this causes rule evaluation to stop after processing this rule.

- `session_affinity: Optional[SessionAffinity]`

  Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ip_cookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `session_affinity_ttl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `session_affinity_attributes` for additional required configuration.

- `session_affinity_attributes: Optional[SessionAffinityAttributesParam]`

  Configures attributes for session affinity.

- `session_affinity_ttl: Optional[float]`

  Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `session_affinity` policy are: - `"cookie"` / `"ip_cookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.

- `steering_policy: Optional[SteeringPolicy]`

  Steering Policy for this load balancer.

  - `"off"`: Use `default_pools`.
  - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.
  - `"random"`: Select a pool randomly.
  - `"dynamic_latency"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).
  - `"proximity"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.
  - `"least_outstanding_requests"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of outstanding requests. Pools with more pending requests are weighted proportionately less relative to others.
  - `"least_connections"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of open connections. Pools with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.
  - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`.

- `ttl: Optional[float]`

  Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

### Returns

- `class LoadBalancer: …`

  - `id: Optional[str]`

  - `adaptive_routing: Optional[AdaptiveRouting]`

    Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.

    - `failover_across_pools: Optional[bool]`

      Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See `session_affinity_attributes` for control over when sessions are broken or reassigned.

  - `country_pools: Optional[Dict[str, List[str]]]`

    A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools.

  - `created_on: Optional[str]`

  - `default_pools: Optional[List[DefaultPools]]`

    A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.

  - `description: Optional[str]`

    Object description.

  - `enabled: Optional[bool]`

    Whether to enable (the default) this load balancer.

  - `fallback_pool: Optional[str]`

    The pool ID to use when all other pools are detected as unhealthy.

  - `location_strategy: Optional[LocationStrategy]`

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

    - `mode: Optional[Literal["pop", "resolver_ip"]]`

      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 the DNS resolver GeoIP location. If the GeoIP lookup is unsuccessful, use the Cloudflare PoP location.

      - `"pop"`

      - `"resolver_ip"`

    - `prefer_ecs: Optional[Literal["always", "never", "proximity", "geo"]]`

      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 `steering_policy="proximity"`.
      - `"geo"`: Prefer ECS only when `steering_policy="geo"`.

      - `"always"`

      - `"never"`

      - `"proximity"`

      - `"geo"`

  - `modified_on: Optional[str]`

  - `name: Optional[str]`

    The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.

  - `networks: Optional[List[str]]`

    List of networks where Load Balancer or Pool is enabled.

  - `pop_pools: Optional[Dict[str, List[str]]]`

    Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.

  - `proxied: Optional[bool]`

    Whether the hostname should be gray clouded (false) or orange clouded (true).

  - `random_steering: Optional[RandomSteering]`

    Configures pool weights.

    - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights.
    - `steering_policy="least_outstanding_requests"`: Use pool weights to scale each pool's outstanding requests.
    - `steering_policy="least_connections"`: Use pool weights to scale each pool's open connections.

    - `default_weight: Optional[float]`

      The default weight for pools in the load balancer that are not specified in the pool_weights map.

    - `pool_weights: Optional[Dict[str, float]]`

      A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.

  - `region_pools: Optional[Dict[str, List[str]]]`

    A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.

  - `rules: Optional[List[Rules]]`

    BETA Field Not General Access: A list of rules for this load balancer to execute.

    - `condition: Optional[str]`

      The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions.

    - `disabled: Optional[bool]`

      Disable this specific rule. It will no longer be evaluated by this load balancer.

    - `fixed_response: Optional[FixedResponse]`

      A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed_response is supplied the rule will be marked as terminates.

      - `content_type: Optional[str]`

        The http 'Content-Type' header to include in the response.

      - `location: Optional[str]`

        The http 'Location' header to include in the response.

      - `message_body: Optional[str]`

        Text to include as the http body.

      - `status_code: Optional[int]`

        The http status code to respond with.

    - `name: Optional[str]`

      Name of this rule. Only used for human readability.

    - `overrides: Optional[Overrides]`

      A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional.

      - `adaptive_routing: Optional[AdaptiveRouting]`

        Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.

      - `country_pools: Optional[Dict[str, List[str]]]`

        A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools.

      - `default_pools: Optional[List[DefaultPools]]`

        A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.

      - `fallback_pool: Optional[str]`

        The pool ID to use when all other pools are detected as unhealthy.

      - `location_strategy: Optional[LocationStrategy]`

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

      - `pop_pools: Optional[Dict[str, List[str]]]`

        Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.

      - `random_steering: Optional[RandomSteering]`

        Configures pool weights.

        - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights.
        - `steering_policy="least_outstanding_requests"`: Use pool weights to scale each pool's outstanding requests.
        - `steering_policy="least_connections"`: Use pool weights to scale each pool's open connections.

      - `region_pools: Optional[Dict[str, List[str]]]`

        A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.

      - `session_affinity: Optional[SessionAffinity]`

        Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ip_cookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `session_affinity_ttl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `session_affinity_attributes` for additional required configuration.

        - `"none"`

        - `"cookie"`

        - `"ip_cookie"`

        - `"header"`

      - `session_affinity_attributes: Optional[SessionAffinityAttributes]`

        Configures attributes for session affinity.

        - `drain_duration: Optional[float]`

          Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.

        - `headers: Optional[List[str]]`

          Configures the names of HTTP headers to base session affinity on when header `session_affinity` is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: `"cookie:<cookie-name-1>,<cookie-name-2>"` (example) where everything after the colon is a comma-separated list of cookie names. Providing only `"cookie"` will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.

        - `require_all_headers: Optional[bool]`

          When header `session_affinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are: - `"true"`: Load balancing requests must contain *all* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created. - `"false"`: Load balancing requests must contain *at least one* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created.

        - `samesite: Optional[Literal["Auto", "Lax", "None", "Strict"]]`

          Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never".

          - `"Auto"`

          - `"Lax"`

          - `"None"`

          - `"Strict"`

        - `secure: Optional[Literal["Auto", "Always", "Never"]]`

          Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled.

          - `"Auto"`

          - `"Always"`

          - `"Never"`

        - `zero_downtime_failover: Optional[Literal["none", "temporary", "sticky"]]`

          Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are: - `"none"`: No failover takes place for sessions pinned to the origin (default). - `"temporary"`: Traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping. - `"sticky"`: The session affinity cookie is updated and subsequent requests are sent to the new origin. Note: Zero-downtime failover with sticky sessions is currently not supported for session affinity by header.

          - `"none"`

          - `"temporary"`

          - `"sticky"`

      - `session_affinity_ttl: Optional[float]`

        Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `session_affinity` policy are: - `"cookie"` / `"ip_cookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.

      - `steering_policy: Optional[SteeringPolicy]`

        Steering Policy for this load balancer.

        - `"off"`: Use `default_pools`.
        - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.
        - `"random"`: Select a pool randomly.
        - `"dynamic_latency"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).
        - `"proximity"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.
        - `"least_outstanding_requests"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of outstanding requests. Pools with more pending requests are weighted proportionately less relative to others.
        - `"least_connections"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of open connections. Pools with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.
        - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`.

        - `"off"`

        - `"geo"`

        - `"random"`

        - `"dynamic_latency"`

        - `"proximity"`

        - `"least_outstanding_requests"`

        - `"least_connections"`

        - `""`

      - `ttl: Optional[float]`

        Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

    - `priority: Optional[int]`

      The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority.

    - `terminates: Optional[bool]`

      If this rule's condition is true, this causes rule evaluation to stop after processing this rule.

  - `session_affinity: Optional[SessionAffinity]`

    Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ip_cookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `session_affinity_ttl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `session_affinity_attributes` for additional required configuration.

  - `session_affinity_attributes: Optional[SessionAffinityAttributes]`

    Configures attributes for session affinity.

  - `session_affinity_ttl: Optional[float]`

    Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `session_affinity` policy are: - `"cookie"` / `"ip_cookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.

  - `steering_policy: Optional[SteeringPolicy]`

    Steering Policy for this load balancer.

    - `"off"`: Use `default_pools`.
    - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.
    - `"random"`: Select a pool randomly.
    - `"dynamic_latency"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).
    - `"proximity"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.
    - `"least_outstanding_requests"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of outstanding requests. Pools with more pending requests are weighted proportionately less relative to others.
    - `"least_connections"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of open connections. Pools with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.
    - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`.

  - `ttl: Optional[float]`

    Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

  - `zone_name: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
load_balancer = client.load_balancers.update(
    load_balancer_id="699d98642c564d2e855e9661899b7252",
    zone_id="699d98642c564d2e855e9661899b7252",
    default_pools=["17b5962d775c646f3f9725cbc7a53df4", "9290f38c5d07c2e2f4df57b1f61d4196", "00920f38ce07c2e2f4df50b1f61d4194"],
    fallback_pool="fallback_pool",
    name="www.example.com",
)
print(load_balancer.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "699d98642c564d2e855e9661899b7252",
    "adaptive_routing": {
      "failover_across_pools": true
    },
    "country_pools": {
      "GB": [
        "abd90f38ced07c2e2f4df50b1f61d4194"
      ],
      "US": [
        "de90f38ced07c2e2f4df50b1f61d4194",
        "00920f38ce07c2e2f4df50b1f61d4194"
      ]
    },
    "created_on": "2014-01-01T05:20:00.12345Z",
    "default_pools": [
      "17b5962d775c646f3f9725cbc7a53df4",
      "9290f38c5d07c2e2f4df57b1f61d4196",
      "00920f38ce07c2e2f4df50b1f61d4194"
    ],
    "description": "Load Balancer for www.example.com",
    "enabled": true,
    "fallback_pool": "fallback_pool",
    "location_strategy": {
      "mode": "resolver_ip",
      "prefer_ecs": "always"
    },
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "www.example.com",
    "networks": [
      "string"
    ],
    "pop_pools": {
      "LAX": [
        "de90f38ced07c2e2f4df50b1f61d4194",
        "9290f38c5d07c2e2f4df57b1f61d4196"
      ],
      "LHR": [
        "abd90f38ced07c2e2f4df50b1f61d4194",
        "f9138c5d07c2e2f4df57b1f61d4196"
      ],
      "SJC": [
        "00920f38ce07c2e2f4df50b1f61d4194"
      ]
    },
    "proxied": true,
    "random_steering": {
      "default_weight": 0.2,
      "pool_weights": {
        "9290f38c5d07c2e2f4df57b1f61d4196": 0.5,
        "de90f38ced07c2e2f4df50b1f61d4194": 0.3
      }
    },
    "region_pools": {
      "ENAM": [
        "00920f38ce07c2e2f4df50b1f61d4194"
      ],
      "WNAM": [
        "de90f38ced07c2e2f4df50b1f61d4194",
        "9290f38c5d07c2e2f4df57b1f61d4196"
      ]
    },
    "rules": [
      {
        "condition": "http.request.uri.path contains \"/testing\"",
        "disabled": true,
        "fixed_response": {
          "content_type": "application/json",
          "location": "www.example.com",
          "message_body": "Testing Hello",
          "status_code": 0
        },
        "name": "route the path /testing to testing datacenter.",
        "overrides": {
          "adaptive_routing": {
            "failover_across_pools": true
          },
          "country_pools": {
            "GB": [
              "abd90f38ced07c2e2f4df50b1f61d4194"
            ],
            "US": [
              "de90f38ced07c2e2f4df50b1f61d4194",
              "00920f38ce07c2e2f4df50b1f61d4194"
            ]
          },
          "default_pools": [
            "17b5962d775c646f3f9725cbc7a53df4",
            "9290f38c5d07c2e2f4df57b1f61d4196",
            "00920f38ce07c2e2f4df50b1f61d4194"
          ],
          "fallback_pool": "fallback_pool",
          "location_strategy": {
            "mode": "resolver_ip",
            "prefer_ecs": "always"
          },
          "pop_pools": {
            "LAX": [
              "de90f38ced07c2e2f4df50b1f61d4194",
              "9290f38c5d07c2e2f4df57b1f61d4196"
            ],
            "LHR": [
              "abd90f38ced07c2e2f4df50b1f61d4194",
              "f9138c5d07c2e2f4df57b1f61d4196"
            ],
            "SJC": [
              "00920f38ce07c2e2f4df50b1f61d4194"
            ]
          },
          "random_steering": {
            "default_weight": 0.2,
            "pool_weights": {
              "9290f38c5d07c2e2f4df57b1f61d4196": 0.5,
              "de90f38ced07c2e2f4df50b1f61d4194": 0.3
            }
          },
          "region_pools": {
            "ENAM": [
              "00920f38ce07c2e2f4df50b1f61d4194"
            ],
            "WNAM": [
              "de90f38ced07c2e2f4df50b1f61d4194",
              "9290f38c5d07c2e2f4df57b1f61d4196"
            ]
          },
          "session_affinity": "cookie",
          "session_affinity_attributes": {
            "drain_duration": 100,
            "headers": [
              "x"
            ],
            "require_all_headers": true,
            "samesite": "Auto",
            "secure": "Auto",
            "zero_downtime_failover": "sticky"
          },
          "session_affinity_ttl": 1800,
          "steering_policy": "dynamic_latency",
          "ttl": 30
        },
        "priority": 0,
        "terminates": true
      }
    ],
    "session_affinity": "cookie",
    "session_affinity_attributes": {
      "drain_duration": 100,
      "headers": [
        "x"
      ],
      "require_all_headers": true,
      "samesite": "Auto",
      "secure": "Auto",
      "zero_downtime_failover": "sticky"
    },
    "session_affinity_ttl": 1800,
    "steering_policy": "dynamic_latency",
    "ttl": 30,
    "zone_name": "example.com"
  },
  "success": true
}
```

## Patch Load Balancer

`load_balancers.edit(strload_balancer_id, LoadBalancerEditParams**kwargs)  -> LoadBalancer`

**patch** `/zones/{zone_id}/load_balancers/{load_balancer_id}`

Apply changes to an existing load balancer, overwriting the supplied properties.

### Parameters

- `zone_id: str`

- `load_balancer_id: str`

- `adaptive_routing: Optional[AdaptiveRoutingParam]`

  Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.

  - `failover_across_pools: Optional[bool]`

    Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See `session_affinity_attributes` for control over when sessions are broken or reassigned.

- `country_pools: Optional[Dict[str, SequenceNotStr[str]]]`

  A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools.

- `default_pools: Optional[SequenceNotStr[DefaultPools]]`

  A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.

- `description: Optional[str]`

  Object description.

- `enabled: Optional[bool]`

  Whether to enable (the default) this load balancer.

- `fallback_pool: Optional[str]`

  The pool ID to use when all other pools are detected as unhealthy.

- `location_strategy: Optional[LocationStrategyParam]`

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

  - `mode: Optional[Literal["pop", "resolver_ip"]]`

    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 the DNS resolver GeoIP location. If the GeoIP lookup is unsuccessful, use the Cloudflare PoP location.

    - `"pop"`

    - `"resolver_ip"`

  - `prefer_ecs: Optional[Literal["always", "never", "proximity", "geo"]]`

    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 `steering_policy="proximity"`.
    - `"geo"`: Prefer ECS only when `steering_policy="geo"`.

    - `"always"`

    - `"never"`

    - `"proximity"`

    - `"geo"`

- `name: Optional[str]`

  The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.

- `pop_pools: Optional[Dict[str, SequenceNotStr[str]]]`

  Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.

- `proxied: Optional[bool]`

  Whether the hostname should be gray clouded (false) or orange clouded (true).

- `random_steering: Optional[RandomSteeringParam]`

  Configures pool weights.

  - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights.
  - `steering_policy="least_outstanding_requests"`: Use pool weights to scale each pool's outstanding requests.
  - `steering_policy="least_connections"`: Use pool weights to scale each pool's open connections.

  - `default_weight: Optional[float]`

    The default weight for pools in the load balancer that are not specified in the pool_weights map.

  - `pool_weights: Optional[Dict[str, float]]`

    A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.

- `region_pools: Optional[Dict[str, SequenceNotStr[str]]]`

  A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.

- `rules: Optional[Iterable[RulesParam]]`

  BETA Field Not General Access: A list of rules for this load balancer to execute.

  - `condition: Optional[str]`

    The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions.

  - `disabled: Optional[bool]`

    Disable this specific rule. It will no longer be evaluated by this load balancer.

  - `fixed_response: Optional[FixedResponse]`

    A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed_response is supplied the rule will be marked as terminates.

    - `content_type: Optional[str]`

      The http 'Content-Type' header to include in the response.

    - `location: Optional[str]`

      The http 'Location' header to include in the response.

    - `message_body: Optional[str]`

      Text to include as the http body.

    - `status_code: Optional[int]`

      The http status code to respond with.

  - `name: Optional[str]`

    Name of this rule. Only used for human readability.

  - `overrides: Optional[Overrides]`

    A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional.

    - `adaptive_routing: Optional[AdaptiveRouting]`

      Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.

    - `country_pools: Optional[Dict[str, List[str]]]`

      A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools.

    - `default_pools: Optional[List[DefaultPools]]`

      A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.

    - `fallback_pool: Optional[str]`

      The pool ID to use when all other pools are detected as unhealthy.

    - `location_strategy: Optional[LocationStrategy]`

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

    - `pop_pools: Optional[Dict[str, List[str]]]`

      Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.

    - `random_steering: Optional[RandomSteering]`

      Configures pool weights.

      - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights.
      - `steering_policy="least_outstanding_requests"`: Use pool weights to scale each pool's outstanding requests.
      - `steering_policy="least_connections"`: Use pool weights to scale each pool's open connections.

    - `region_pools: Optional[Dict[str, List[str]]]`

      A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.

    - `session_affinity: Optional[SessionAffinity]`

      Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ip_cookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `session_affinity_ttl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `session_affinity_attributes` for additional required configuration.

      - `"none"`

      - `"cookie"`

      - `"ip_cookie"`

      - `"header"`

    - `session_affinity_attributes: Optional[SessionAffinityAttributes]`

      Configures attributes for session affinity.

      - `drain_duration: Optional[float]`

        Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.

      - `headers: Optional[List[str]]`

        Configures the names of HTTP headers to base session affinity on when header `session_affinity` is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: `"cookie:<cookie-name-1>,<cookie-name-2>"` (example) where everything after the colon is a comma-separated list of cookie names. Providing only `"cookie"` will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.

      - `require_all_headers: Optional[bool]`

        When header `session_affinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are: - `"true"`: Load balancing requests must contain *all* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created. - `"false"`: Load balancing requests must contain *at least one* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created.

      - `samesite: Optional[Literal["Auto", "Lax", "None", "Strict"]]`

        Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never".

        - `"Auto"`

        - `"Lax"`

        - `"None"`

        - `"Strict"`

      - `secure: Optional[Literal["Auto", "Always", "Never"]]`

        Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled.

        - `"Auto"`

        - `"Always"`

        - `"Never"`

      - `zero_downtime_failover: Optional[Literal["none", "temporary", "sticky"]]`

        Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are: - `"none"`: No failover takes place for sessions pinned to the origin (default). - `"temporary"`: Traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping. - `"sticky"`: The session affinity cookie is updated and subsequent requests are sent to the new origin. Note: Zero-downtime failover with sticky sessions is currently not supported for session affinity by header.

        - `"none"`

        - `"temporary"`

        - `"sticky"`

    - `session_affinity_ttl: Optional[float]`

      Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `session_affinity` policy are: - `"cookie"` / `"ip_cookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.

    - `steering_policy: Optional[SteeringPolicy]`

      Steering Policy for this load balancer.

      - `"off"`: Use `default_pools`.
      - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.
      - `"random"`: Select a pool randomly.
      - `"dynamic_latency"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).
      - `"proximity"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.
      - `"least_outstanding_requests"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of outstanding requests. Pools with more pending requests are weighted proportionately less relative to others.
      - `"least_connections"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of open connections. Pools with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.
      - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`.

      - `"off"`

      - `"geo"`

      - `"random"`

      - `"dynamic_latency"`

      - `"proximity"`

      - `"least_outstanding_requests"`

      - `"least_connections"`

      - `""`

    - `ttl: Optional[float]`

      Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

  - `priority: Optional[int]`

    The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority.

  - `terminates: Optional[bool]`

    If this rule's condition is true, this causes rule evaluation to stop after processing this rule.

- `session_affinity: Optional[SessionAffinity]`

  Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ip_cookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `session_affinity_ttl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `session_affinity_attributes` for additional required configuration.

- `session_affinity_attributes: Optional[SessionAffinityAttributesParam]`

  Configures attributes for session affinity.

- `session_affinity_ttl: Optional[float]`

  Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `session_affinity` policy are: - `"cookie"` / `"ip_cookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.

- `steering_policy: Optional[SteeringPolicy]`

  Steering Policy for this load balancer.

  - `"off"`: Use `default_pools`.
  - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.
  - `"random"`: Select a pool randomly.
  - `"dynamic_latency"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).
  - `"proximity"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.
  - `"least_outstanding_requests"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of outstanding requests. Pools with more pending requests are weighted proportionately less relative to others.
  - `"least_connections"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of open connections. Pools with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.
  - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`.

- `ttl: Optional[float]`

  Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

### Returns

- `class LoadBalancer: …`

  - `id: Optional[str]`

  - `adaptive_routing: Optional[AdaptiveRouting]`

    Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.

    - `failover_across_pools: Optional[bool]`

      Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See `session_affinity_attributes` for control over when sessions are broken or reassigned.

  - `country_pools: Optional[Dict[str, List[str]]]`

    A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools.

  - `created_on: Optional[str]`

  - `default_pools: Optional[List[DefaultPools]]`

    A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.

  - `description: Optional[str]`

    Object description.

  - `enabled: Optional[bool]`

    Whether to enable (the default) this load balancer.

  - `fallback_pool: Optional[str]`

    The pool ID to use when all other pools are detected as unhealthy.

  - `location_strategy: Optional[LocationStrategy]`

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

    - `mode: Optional[Literal["pop", "resolver_ip"]]`

      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 the DNS resolver GeoIP location. If the GeoIP lookup is unsuccessful, use the Cloudflare PoP location.

      - `"pop"`

      - `"resolver_ip"`

    - `prefer_ecs: Optional[Literal["always", "never", "proximity", "geo"]]`

      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 `steering_policy="proximity"`.
      - `"geo"`: Prefer ECS only when `steering_policy="geo"`.

      - `"always"`

      - `"never"`

      - `"proximity"`

      - `"geo"`

  - `modified_on: Optional[str]`

  - `name: Optional[str]`

    The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.

  - `networks: Optional[List[str]]`

    List of networks where Load Balancer or Pool is enabled.

  - `pop_pools: Optional[Dict[str, List[str]]]`

    Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.

  - `proxied: Optional[bool]`

    Whether the hostname should be gray clouded (false) or orange clouded (true).

  - `random_steering: Optional[RandomSteering]`

    Configures pool weights.

    - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights.
    - `steering_policy="least_outstanding_requests"`: Use pool weights to scale each pool's outstanding requests.
    - `steering_policy="least_connections"`: Use pool weights to scale each pool's open connections.

    - `default_weight: Optional[float]`

      The default weight for pools in the load balancer that are not specified in the pool_weights map.

    - `pool_weights: Optional[Dict[str, float]]`

      A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.

  - `region_pools: Optional[Dict[str, List[str]]]`

    A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.

  - `rules: Optional[List[Rules]]`

    BETA Field Not General Access: A list of rules for this load balancer to execute.

    - `condition: Optional[str]`

      The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions.

    - `disabled: Optional[bool]`

      Disable this specific rule. It will no longer be evaluated by this load balancer.

    - `fixed_response: Optional[FixedResponse]`

      A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed_response is supplied the rule will be marked as terminates.

      - `content_type: Optional[str]`

        The http 'Content-Type' header to include in the response.

      - `location: Optional[str]`

        The http 'Location' header to include in the response.

      - `message_body: Optional[str]`

        Text to include as the http body.

      - `status_code: Optional[int]`

        The http status code to respond with.

    - `name: Optional[str]`

      Name of this rule. Only used for human readability.

    - `overrides: Optional[Overrides]`

      A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional.

      - `adaptive_routing: Optional[AdaptiveRouting]`

        Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.

      - `country_pools: Optional[Dict[str, List[str]]]`

        A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools.

      - `default_pools: Optional[List[DefaultPools]]`

        A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.

      - `fallback_pool: Optional[str]`

        The pool ID to use when all other pools are detected as unhealthy.

      - `location_strategy: Optional[LocationStrategy]`

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

      - `pop_pools: Optional[Dict[str, List[str]]]`

        Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.

      - `random_steering: Optional[RandomSteering]`

        Configures pool weights.

        - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights.
        - `steering_policy="least_outstanding_requests"`: Use pool weights to scale each pool's outstanding requests.
        - `steering_policy="least_connections"`: Use pool weights to scale each pool's open connections.

      - `region_pools: Optional[Dict[str, List[str]]]`

        A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.

      - `session_affinity: Optional[SessionAffinity]`

        Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ip_cookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `session_affinity_ttl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `session_affinity_attributes` for additional required configuration.

        - `"none"`

        - `"cookie"`

        - `"ip_cookie"`

        - `"header"`

      - `session_affinity_attributes: Optional[SessionAffinityAttributes]`

        Configures attributes for session affinity.

        - `drain_duration: Optional[float]`

          Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.

        - `headers: Optional[List[str]]`

          Configures the names of HTTP headers to base session affinity on when header `session_affinity` is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: `"cookie:<cookie-name-1>,<cookie-name-2>"` (example) where everything after the colon is a comma-separated list of cookie names. Providing only `"cookie"` will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.

        - `require_all_headers: Optional[bool]`

          When header `session_affinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are: - `"true"`: Load balancing requests must contain *all* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created. - `"false"`: Load balancing requests must contain *at least one* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created.

        - `samesite: Optional[Literal["Auto", "Lax", "None", "Strict"]]`

          Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never".

          - `"Auto"`

          - `"Lax"`

          - `"None"`

          - `"Strict"`

        - `secure: Optional[Literal["Auto", "Always", "Never"]]`

          Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled.

          - `"Auto"`

          - `"Always"`

          - `"Never"`

        - `zero_downtime_failover: Optional[Literal["none", "temporary", "sticky"]]`

          Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are: - `"none"`: No failover takes place for sessions pinned to the origin (default). - `"temporary"`: Traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping. - `"sticky"`: The session affinity cookie is updated and subsequent requests are sent to the new origin. Note: Zero-downtime failover with sticky sessions is currently not supported for session affinity by header.

          - `"none"`

          - `"temporary"`

          - `"sticky"`

      - `session_affinity_ttl: Optional[float]`

        Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `session_affinity` policy are: - `"cookie"` / `"ip_cookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.

      - `steering_policy: Optional[SteeringPolicy]`

        Steering Policy for this load balancer.

        - `"off"`: Use `default_pools`.
        - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.
        - `"random"`: Select a pool randomly.
        - `"dynamic_latency"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).
        - `"proximity"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.
        - `"least_outstanding_requests"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of outstanding requests. Pools with more pending requests are weighted proportionately less relative to others.
        - `"least_connections"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of open connections. Pools with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.
        - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`.

        - `"off"`

        - `"geo"`

        - `"random"`

        - `"dynamic_latency"`

        - `"proximity"`

        - `"least_outstanding_requests"`

        - `"least_connections"`

        - `""`

      - `ttl: Optional[float]`

        Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

    - `priority: Optional[int]`

      The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority.

    - `terminates: Optional[bool]`

      If this rule's condition is true, this causes rule evaluation to stop after processing this rule.

  - `session_affinity: Optional[SessionAffinity]`

    Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ip_cookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `session_affinity_ttl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `session_affinity_attributes` for additional required configuration.

  - `session_affinity_attributes: Optional[SessionAffinityAttributes]`

    Configures attributes for session affinity.

  - `session_affinity_ttl: Optional[float]`

    Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `session_affinity` policy are: - `"cookie"` / `"ip_cookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.

  - `steering_policy: Optional[SteeringPolicy]`

    Steering Policy for this load balancer.

    - `"off"`: Use `default_pools`.
    - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.
    - `"random"`: Select a pool randomly.
    - `"dynamic_latency"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).
    - `"proximity"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.
    - `"least_outstanding_requests"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of outstanding requests. Pools with more pending requests are weighted proportionately less relative to others.
    - `"least_connections"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of open connections. Pools with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.
    - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`.

  - `ttl: Optional[float]`

    Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

  - `zone_name: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
load_balancer = client.load_balancers.edit(
    load_balancer_id="699d98642c564d2e855e9661899b7252",
    zone_id="699d98642c564d2e855e9661899b7252",
)
print(load_balancer.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "699d98642c564d2e855e9661899b7252",
    "adaptive_routing": {
      "failover_across_pools": true
    },
    "country_pools": {
      "GB": [
        "abd90f38ced07c2e2f4df50b1f61d4194"
      ],
      "US": [
        "de90f38ced07c2e2f4df50b1f61d4194",
        "00920f38ce07c2e2f4df50b1f61d4194"
      ]
    },
    "created_on": "2014-01-01T05:20:00.12345Z",
    "default_pools": [
      "17b5962d775c646f3f9725cbc7a53df4",
      "9290f38c5d07c2e2f4df57b1f61d4196",
      "00920f38ce07c2e2f4df50b1f61d4194"
    ],
    "description": "Load Balancer for www.example.com",
    "enabled": true,
    "fallback_pool": "fallback_pool",
    "location_strategy": {
      "mode": "resolver_ip",
      "prefer_ecs": "always"
    },
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "www.example.com",
    "networks": [
      "string"
    ],
    "pop_pools": {
      "LAX": [
        "de90f38ced07c2e2f4df50b1f61d4194",
        "9290f38c5d07c2e2f4df57b1f61d4196"
      ],
      "LHR": [
        "abd90f38ced07c2e2f4df50b1f61d4194",
        "f9138c5d07c2e2f4df57b1f61d4196"
      ],
      "SJC": [
        "00920f38ce07c2e2f4df50b1f61d4194"
      ]
    },
    "proxied": true,
    "random_steering": {
      "default_weight": 0.2,
      "pool_weights": {
        "9290f38c5d07c2e2f4df57b1f61d4196": 0.5,
        "de90f38ced07c2e2f4df50b1f61d4194": 0.3
      }
    },
    "region_pools": {
      "ENAM": [
        "00920f38ce07c2e2f4df50b1f61d4194"
      ],
      "WNAM": [
        "de90f38ced07c2e2f4df50b1f61d4194",
        "9290f38c5d07c2e2f4df57b1f61d4196"
      ]
    },
    "rules": [
      {
        "condition": "http.request.uri.path contains \"/testing\"",
        "disabled": true,
        "fixed_response": {
          "content_type": "application/json",
          "location": "www.example.com",
          "message_body": "Testing Hello",
          "status_code": 0
        },
        "name": "route the path /testing to testing datacenter.",
        "overrides": {
          "adaptive_routing": {
            "failover_across_pools": true
          },
          "country_pools": {
            "GB": [
              "abd90f38ced07c2e2f4df50b1f61d4194"
            ],
            "US": [
              "de90f38ced07c2e2f4df50b1f61d4194",
              "00920f38ce07c2e2f4df50b1f61d4194"
            ]
          },
          "default_pools": [
            "17b5962d775c646f3f9725cbc7a53df4",
            "9290f38c5d07c2e2f4df57b1f61d4196",
            "00920f38ce07c2e2f4df50b1f61d4194"
          ],
          "fallback_pool": "fallback_pool",
          "location_strategy": {
            "mode": "resolver_ip",
            "prefer_ecs": "always"
          },
          "pop_pools": {
            "LAX": [
              "de90f38ced07c2e2f4df50b1f61d4194",
              "9290f38c5d07c2e2f4df57b1f61d4196"
            ],
            "LHR": [
              "abd90f38ced07c2e2f4df50b1f61d4194",
              "f9138c5d07c2e2f4df57b1f61d4196"
            ],
            "SJC": [
              "00920f38ce07c2e2f4df50b1f61d4194"
            ]
          },
          "random_steering": {
            "default_weight": 0.2,
            "pool_weights": {
              "9290f38c5d07c2e2f4df57b1f61d4196": 0.5,
              "de90f38ced07c2e2f4df50b1f61d4194": 0.3
            }
          },
          "region_pools": {
            "ENAM": [
              "00920f38ce07c2e2f4df50b1f61d4194"
            ],
            "WNAM": [
              "de90f38ced07c2e2f4df50b1f61d4194",
              "9290f38c5d07c2e2f4df57b1f61d4196"
            ]
          },
          "session_affinity": "cookie",
          "session_affinity_attributes": {
            "drain_duration": 100,
            "headers": [
              "x"
            ],
            "require_all_headers": true,
            "samesite": "Auto",
            "secure": "Auto",
            "zero_downtime_failover": "sticky"
          },
          "session_affinity_ttl": 1800,
          "steering_policy": "dynamic_latency",
          "ttl": 30
        },
        "priority": 0,
        "terminates": true
      }
    ],
    "session_affinity": "cookie",
    "session_affinity_attributes": {
      "drain_duration": 100,
      "headers": [
        "x"
      ],
      "require_all_headers": true,
      "samesite": "Auto",
      "secure": "Auto",
      "zero_downtime_failover": "sticky"
    },
    "session_affinity_ttl": 1800,
    "steering_policy": "dynamic_latency",
    "ttl": 30,
    "zone_name": "example.com"
  },
  "success": true
}
```

## Delete Load Balancer

`load_balancers.delete(strload_balancer_id, LoadBalancerDeleteParams**kwargs)  -> LoadBalancerDeleteResponse`

**delete** `/zones/{zone_id}/load_balancers/{load_balancer_id}`

Delete a configured load balancer.

### Parameters

- `zone_id: str`

- `load_balancer_id: str`

### Returns

- `class LoadBalancerDeleteResponse: …`

  - `id: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
load_balancer = client.load_balancers.delete(
    load_balancer_id="699d98642c564d2e855e9661899b7252",
    zone_id="699d98642c564d2e855e9661899b7252",
)
print(load_balancer.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "699d98642c564d2e855e9661899b7252"
  },
  "success": true
}
```

## Domain Types

### Adaptive Routing

- `class AdaptiveRouting: …`

  Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.

  - `failover_across_pools: Optional[bool]`

    Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See `session_affinity_attributes` for control over when sessions are broken or reassigned.

### Check Region

- `Literal["WNAM", "ENAM", "WEU", 11 more]`

  WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, SAS: Southern Asia, SEAS: South East Asia, NEAS: North East Asia, ALL_REGIONS: all regions (ENTERPRISE customers only).

  - `"WNAM"`

  - `"ENAM"`

  - `"WEU"`

  - `"EEU"`

  - `"NSAM"`

  - `"SSAM"`

  - `"OC"`

  - `"ME"`

  - `"NAF"`

  - `"SAF"`

  - `"SAS"`

  - `"SEAS"`

  - `"NEAS"`

  - `"ALL_REGIONS"`

### Default Pools

- `str`

  A pool ID.

### Filter Options

- `class FilterOptions: …`

  Filter options for a particular resource type (pool or origin). Use null to reset.

  - `disable: Optional[bool]`

    If set true, disable notifications for this type of resource (pool or origin).

  - `healthy: Optional[bool]`

    If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).

### Header

- `class Header: …`

  The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.

  - `host: Optional[List[Host]]`

    The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.

### Host

- `str`

### Load Balancer

- `class LoadBalancer: …`

  - `id: Optional[str]`

  - `adaptive_routing: Optional[AdaptiveRouting]`

    Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.

    - `failover_across_pools: Optional[bool]`

      Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See `session_affinity_attributes` for control over when sessions are broken or reassigned.

  - `country_pools: Optional[Dict[str, List[str]]]`

    A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools.

  - `created_on: Optional[str]`

  - `default_pools: Optional[List[DefaultPools]]`

    A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.

  - `description: Optional[str]`

    Object description.

  - `enabled: Optional[bool]`

    Whether to enable (the default) this load balancer.

  - `fallback_pool: Optional[str]`

    The pool ID to use when all other pools are detected as unhealthy.

  - `location_strategy: Optional[LocationStrategy]`

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

    - `mode: Optional[Literal["pop", "resolver_ip"]]`

      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 the DNS resolver GeoIP location. If the GeoIP lookup is unsuccessful, use the Cloudflare PoP location.

      - `"pop"`

      - `"resolver_ip"`

    - `prefer_ecs: Optional[Literal["always", "never", "proximity", "geo"]]`

      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 `steering_policy="proximity"`.
      - `"geo"`: Prefer ECS only when `steering_policy="geo"`.

      - `"always"`

      - `"never"`

      - `"proximity"`

      - `"geo"`

  - `modified_on: Optional[str]`

  - `name: Optional[str]`

    The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.

  - `networks: Optional[List[str]]`

    List of networks where Load Balancer or Pool is enabled.

  - `pop_pools: Optional[Dict[str, List[str]]]`

    Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.

  - `proxied: Optional[bool]`

    Whether the hostname should be gray clouded (false) or orange clouded (true).

  - `random_steering: Optional[RandomSteering]`

    Configures pool weights.

    - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights.
    - `steering_policy="least_outstanding_requests"`: Use pool weights to scale each pool's outstanding requests.
    - `steering_policy="least_connections"`: Use pool weights to scale each pool's open connections.

    - `default_weight: Optional[float]`

      The default weight for pools in the load balancer that are not specified in the pool_weights map.

    - `pool_weights: Optional[Dict[str, float]]`

      A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.

  - `region_pools: Optional[Dict[str, List[str]]]`

    A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.

  - `rules: Optional[List[Rules]]`

    BETA Field Not General Access: A list of rules for this load balancer to execute.

    - `condition: Optional[str]`

      The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions.

    - `disabled: Optional[bool]`

      Disable this specific rule. It will no longer be evaluated by this load balancer.

    - `fixed_response: Optional[FixedResponse]`

      A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed_response is supplied the rule will be marked as terminates.

      - `content_type: Optional[str]`

        The http 'Content-Type' header to include in the response.

      - `location: Optional[str]`

        The http 'Location' header to include in the response.

      - `message_body: Optional[str]`

        Text to include as the http body.

      - `status_code: Optional[int]`

        The http status code to respond with.

    - `name: Optional[str]`

      Name of this rule. Only used for human readability.

    - `overrides: Optional[Overrides]`

      A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional.

      - `adaptive_routing: Optional[AdaptiveRouting]`

        Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.

      - `country_pools: Optional[Dict[str, List[str]]]`

        A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools.

      - `default_pools: Optional[List[DefaultPools]]`

        A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.

      - `fallback_pool: Optional[str]`

        The pool ID to use when all other pools are detected as unhealthy.

      - `location_strategy: Optional[LocationStrategy]`

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

      - `pop_pools: Optional[Dict[str, List[str]]]`

        Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.

      - `random_steering: Optional[RandomSteering]`

        Configures pool weights.

        - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights.
        - `steering_policy="least_outstanding_requests"`: Use pool weights to scale each pool's outstanding requests.
        - `steering_policy="least_connections"`: Use pool weights to scale each pool's open connections.

      - `region_pools: Optional[Dict[str, List[str]]]`

        A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.

      - `session_affinity: Optional[SessionAffinity]`

        Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ip_cookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `session_affinity_ttl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `session_affinity_attributes` for additional required configuration.

        - `"none"`

        - `"cookie"`

        - `"ip_cookie"`

        - `"header"`

      - `session_affinity_attributes: Optional[SessionAffinityAttributes]`

        Configures attributes for session affinity.

        - `drain_duration: Optional[float]`

          Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.

        - `headers: Optional[List[str]]`

          Configures the names of HTTP headers to base session affinity on when header `session_affinity` is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: `"cookie:<cookie-name-1>,<cookie-name-2>"` (example) where everything after the colon is a comma-separated list of cookie names. Providing only `"cookie"` will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.

        - `require_all_headers: Optional[bool]`

          When header `session_affinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are: - `"true"`: Load balancing requests must contain *all* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created. - `"false"`: Load balancing requests must contain *at least one* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created.

        - `samesite: Optional[Literal["Auto", "Lax", "None", "Strict"]]`

          Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never".

          - `"Auto"`

          - `"Lax"`

          - `"None"`

          - `"Strict"`

        - `secure: Optional[Literal["Auto", "Always", "Never"]]`

          Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled.

          - `"Auto"`

          - `"Always"`

          - `"Never"`

        - `zero_downtime_failover: Optional[Literal["none", "temporary", "sticky"]]`

          Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are: - `"none"`: No failover takes place for sessions pinned to the origin (default). - `"temporary"`: Traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping. - `"sticky"`: The session affinity cookie is updated and subsequent requests are sent to the new origin. Note: Zero-downtime failover with sticky sessions is currently not supported for session affinity by header.

          - `"none"`

          - `"temporary"`

          - `"sticky"`

      - `session_affinity_ttl: Optional[float]`

        Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `session_affinity` policy are: - `"cookie"` / `"ip_cookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.

      - `steering_policy: Optional[SteeringPolicy]`

        Steering Policy for this load balancer.

        - `"off"`: Use `default_pools`.
        - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.
        - `"random"`: Select a pool randomly.
        - `"dynamic_latency"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).
        - `"proximity"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.
        - `"least_outstanding_requests"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of outstanding requests. Pools with more pending requests are weighted proportionately less relative to others.
        - `"least_connections"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of open connections. Pools with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.
        - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`.

        - `"off"`

        - `"geo"`

        - `"random"`

        - `"dynamic_latency"`

        - `"proximity"`

        - `"least_outstanding_requests"`

        - `"least_connections"`

        - `""`

      - `ttl: Optional[float]`

        Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

    - `priority: Optional[int]`

      The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority.

    - `terminates: Optional[bool]`

      If this rule's condition is true, this causes rule evaluation to stop after processing this rule.

  - `session_affinity: Optional[SessionAffinity]`

    Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ip_cookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `session_affinity_ttl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `session_affinity_attributes` for additional required configuration.

  - `session_affinity_attributes: Optional[SessionAffinityAttributes]`

    Configures attributes for session affinity.

  - `session_affinity_ttl: Optional[float]`

    Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `session_affinity` policy are: - `"cookie"` / `"ip_cookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.

  - `steering_policy: Optional[SteeringPolicy]`

    Steering Policy for this load balancer.

    - `"off"`: Use `default_pools`.
    - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.
    - `"random"`: Select a pool randomly.
    - `"dynamic_latency"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).
    - `"proximity"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.
    - `"least_outstanding_requests"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of outstanding requests. Pools with more pending requests are weighted proportionately less relative to others.
    - `"least_connections"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of open connections. Pools with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.
    - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`.

  - `ttl: Optional[float]`

    Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

  - `zone_name: Optional[str]`

### Load Shedding

- `class LoadShedding: …`

  Configures load shedding policies and percentages for the pool.

  - `default_percent: Optional[float]`

    The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.

  - `default_policy: Optional[Literal["random", "hash"]]`

    The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs.

    - `"random"`

    - `"hash"`

  - `session_percent: Optional[float]`

    The percent of existing sessions to shed from the pool, according to the session policy.

  - `session_policy: Optional[Literal["hash"]]`

    Only the hash policy is supported for existing sessions (to avoid exponential decay).

    - `"hash"`

### Location Strategy

- `class LocationStrategy: …`

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

  - `mode: Optional[Literal["pop", "resolver_ip"]]`

    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 the DNS resolver GeoIP location. If the GeoIP lookup is unsuccessful, use the Cloudflare PoP location.

    - `"pop"`

    - `"resolver_ip"`

  - `prefer_ecs: Optional[Literal["always", "never", "proximity", "geo"]]`

    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 `steering_policy="proximity"`.
    - `"geo"`: Prefer ECS only when `steering_policy="geo"`.

    - `"always"`

    - `"never"`

    - `"proximity"`

    - `"geo"`

### Notification Filter

- `class NotificationFilter: …`

  Filter pool and origin health notifications by resource type or health status. Use null to reset.

  - `origin: Optional[FilterOptions]`

    Filter options for a particular resource type (pool or origin). Use null to reset.

    - `disable: Optional[bool]`

      If set true, disable notifications for this type of resource (pool or origin).

    - `healthy: Optional[bool]`

      If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).

  - `pool: Optional[FilterOptions]`

    Filter options for a particular resource type (pool or origin). Use null to reset.

### Origin

- `class Origin: …`

  - `address: Optional[str]`

    The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set.

  - `disabled_at: Optional[datetime]`

    This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.

  - `enabled: Optional[bool]`

    Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.

  - `header: Optional[Header]`

    The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.

    - `host: Optional[List[Host]]`

      The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.

  - `name: Optional[str]`

    A human-identifiable name for the origin.

  - `port: Optional[int]`

    The port for upstream connections. A value of 0 means the default port for the protocol will be used.

  - `virtual_network_id: Optional[str]`

    The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.

  - `weight: Optional[float]`

    The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.

    - `origin_steering.policy="least_outstanding_requests"`: Use weight to scale the origin's outstanding requests.
    - `origin_steering.policy="least_connections"`: Use weight to scale the origin's open connections.

### Origin Steering

- `class OriginSteering: …`

  Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.

  - `policy: Optional[Literal["random", "hash", "least_outstanding_requests", "least_connections"]]`

    The type of origin steering policy to use.

    - `"random"`: Select an origin randomly.
    - `"hash"`: Select an origin by computing a hash over the CF-Connecting-IP address.
    - `"least_outstanding_requests"`: Select an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others.
    - `"least_connections"`: Select an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.

    - `"random"`

    - `"hash"`

    - `"least_outstanding_requests"`

    - `"least_connections"`

### Random Steering

- `class RandomSteering: …`

  Configures pool weights.

  - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights.
  - `steering_policy="least_outstanding_requests"`: Use pool weights to scale each pool's outstanding requests.
  - `steering_policy="least_connections"`: Use pool weights to scale each pool's open connections.

  - `default_weight: Optional[float]`

    The default weight for pools in the load balancer that are not specified in the pool_weights map.

  - `pool_weights: Optional[Dict[str, float]]`

    A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.

### Rules

- `class Rules: …`

  A rule object containing conditions and overrides for this load balancer to evaluate.

  - `condition: Optional[str]`

    The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions.

  - `disabled: Optional[bool]`

    Disable this specific rule. It will no longer be evaluated by this load balancer.

  - `fixed_response: Optional[FixedResponse]`

    A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed_response is supplied the rule will be marked as terminates.

    - `content_type: Optional[str]`

      The http 'Content-Type' header to include in the response.

    - `location: Optional[str]`

      The http 'Location' header to include in the response.

    - `message_body: Optional[str]`

      Text to include as the http body.

    - `status_code: Optional[int]`

      The http status code to respond with.

  - `name: Optional[str]`

    Name of this rule. Only used for human readability.

  - `overrides: Optional[Overrides]`

    A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional.

    - `adaptive_routing: Optional[AdaptiveRouting]`

      Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.

      - `failover_across_pools: Optional[bool]`

        Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See `session_affinity_attributes` for control over when sessions are broken or reassigned.

    - `country_pools: Optional[Dict[str, List[str]]]`

      A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools.

    - `default_pools: Optional[List[DefaultPools]]`

      A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.

    - `fallback_pool: Optional[str]`

      The pool ID to use when all other pools are detected as unhealthy.

    - `location_strategy: Optional[LocationStrategy]`

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

      - `mode: Optional[Literal["pop", "resolver_ip"]]`

        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 the DNS resolver GeoIP location. If the GeoIP lookup is unsuccessful, use the Cloudflare PoP location.

        - `"pop"`

        - `"resolver_ip"`

      - `prefer_ecs: Optional[Literal["always", "never", "proximity", "geo"]]`

        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 `steering_policy="proximity"`.
        - `"geo"`: Prefer ECS only when `steering_policy="geo"`.

        - `"always"`

        - `"never"`

        - `"proximity"`

        - `"geo"`

    - `pop_pools: Optional[Dict[str, List[str]]]`

      Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.

    - `random_steering: Optional[RandomSteering]`

      Configures pool weights.

      - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights.
      - `steering_policy="least_outstanding_requests"`: Use pool weights to scale each pool's outstanding requests.
      - `steering_policy="least_connections"`: Use pool weights to scale each pool's open connections.

      - `default_weight: Optional[float]`

        The default weight for pools in the load balancer that are not specified in the pool_weights map.

      - `pool_weights: Optional[Dict[str, float]]`

        A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.

    - `region_pools: Optional[Dict[str, List[str]]]`

      A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.

    - `session_affinity: Optional[SessionAffinity]`

      Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ip_cookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `session_affinity_ttl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `session_affinity_attributes` for additional required configuration.

      - `"none"`

      - `"cookie"`

      - `"ip_cookie"`

      - `"header"`

    - `session_affinity_attributes: Optional[SessionAffinityAttributes]`

      Configures attributes for session affinity.

      - `drain_duration: Optional[float]`

        Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.

      - `headers: Optional[List[str]]`

        Configures the names of HTTP headers to base session affinity on when header `session_affinity` is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: `"cookie:<cookie-name-1>,<cookie-name-2>"` (example) where everything after the colon is a comma-separated list of cookie names. Providing only `"cookie"` will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.

      - `require_all_headers: Optional[bool]`

        When header `session_affinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are: - `"true"`: Load balancing requests must contain *all* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created. - `"false"`: Load balancing requests must contain *at least one* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created.

      - `samesite: Optional[Literal["Auto", "Lax", "None", "Strict"]]`

        Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never".

        - `"Auto"`

        - `"Lax"`

        - `"None"`

        - `"Strict"`

      - `secure: Optional[Literal["Auto", "Always", "Never"]]`

        Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled.

        - `"Auto"`

        - `"Always"`

        - `"Never"`

      - `zero_downtime_failover: Optional[Literal["none", "temporary", "sticky"]]`

        Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are: - `"none"`: No failover takes place for sessions pinned to the origin (default). - `"temporary"`: Traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping. - `"sticky"`: The session affinity cookie is updated and subsequent requests are sent to the new origin. Note: Zero-downtime failover with sticky sessions is currently not supported for session affinity by header.

        - `"none"`

        - `"temporary"`

        - `"sticky"`

    - `session_affinity_ttl: Optional[float]`

      Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `session_affinity` policy are: - `"cookie"` / `"ip_cookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.

    - `steering_policy: Optional[SteeringPolicy]`

      Steering Policy for this load balancer.

      - `"off"`: Use `default_pools`.
      - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.
      - `"random"`: Select a pool randomly.
      - `"dynamic_latency"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).
      - `"proximity"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.
      - `"least_outstanding_requests"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of outstanding requests. Pools with more pending requests are weighted proportionately less relative to others.
      - `"least_connections"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of open connections. Pools with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.
      - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`.

      - `"off"`

      - `"geo"`

      - `"random"`

      - `"dynamic_latency"`

      - `"proximity"`

      - `"least_outstanding_requests"`

      - `"least_connections"`

      - `""`

    - `ttl: Optional[float]`

      Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.

  - `priority: Optional[int]`

    The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority.

  - `terminates: Optional[bool]`

    If this rule's condition is true, this causes rule evaluation to stop after processing this rule.

### Session Affinity

- `Literal["none", "cookie", "ip_cookie", "header"]`

  Specifies the type of session affinity the load balancer should use unless specified as `"none"`. The supported types are: - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `"ip_cookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client's ip address. - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `session_affinity_ttl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `session_affinity_attributes` for additional required configuration.

  - `"none"`

  - `"cookie"`

  - `"ip_cookie"`

  - `"header"`

### Session Affinity Attributes

- `class SessionAffinityAttributes: …`

  Configures attributes for session affinity.

  - `drain_duration: Optional[float]`

    Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.

  - `headers: Optional[List[str]]`

    Configures the names of HTTP headers to base session affinity on when header `session_affinity` is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: `"cookie:<cookie-name-1>,<cookie-name-2>"` (example) where everything after the colon is a comma-separated list of cookie names. Providing only `"cookie"` will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.

  - `require_all_headers: Optional[bool]`

    When header `session_affinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are: - `"true"`: Load balancing requests must contain *all* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created. - `"false"`: Load balancing requests must contain *at least one* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created.

  - `samesite: Optional[Literal["Auto", "Lax", "None", "Strict"]]`

    Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never".

    - `"Auto"`

    - `"Lax"`

    - `"None"`

    - `"Strict"`

  - `secure: Optional[Literal["Auto", "Always", "Never"]]`

    Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled.

    - `"Auto"`

    - `"Always"`

    - `"Never"`

  - `zero_downtime_failover: Optional[Literal["none", "temporary", "sticky"]]`

    Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are: - `"none"`: No failover takes place for sessions pinned to the origin (default). - `"temporary"`: Traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping. - `"sticky"`: The session affinity cookie is updated and subsequent requests are sent to the new origin. Note: Zero-downtime failover with sticky sessions is currently not supported for session affinity by header.

    - `"none"`

    - `"temporary"`

    - `"sticky"`

### Steering Policy

- `Literal["off", "geo", "random", 5 more]`

  Steering Policy for this load balancer.

  - `"off"`: Use `default_pools`.
  - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.
  - `"random"`: Select a pool randomly.
  - `"dynamic_latency"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).
  - `"proximity"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.
  - `"least_outstanding_requests"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of outstanding requests. Pools with more pending requests are weighted proportionately less relative to others.
  - `"least_connections"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of open connections. Pools with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.
  - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`.

  - `"off"`

  - `"geo"`

  - `"random"`

  - `"dynamic_latency"`

  - `"proximity"`

  - `"least_outstanding_requests"`

  - `"least_connections"`

  - `""`

### Load Balancer Delete Response

- `class LoadBalancerDeleteResponse: …`

  - `id: Optional[str]`

# Monitors

## List Monitors

`load_balancers.monitors.list(MonitorListParams**kwargs)  -> SyncSinglePage[Monitor]`

**get** `/accounts/{account_id}/load_balancers/monitors`

List configured monitors for an account.

### Parameters

- `account_id: str`

  Identifier.

### Returns

- `class Monitor: …`

  - `id: Optional[str]`

  - `allow_insecure: Optional[bool]`

    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.

  - `consecutive_down: Optional[int]`

    To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.

  - `consecutive_up: Optional[int]`

    To be marked healthy the monitored origin must pass this healthcheck N consecutive times.

  - `created_on: Optional[str]`

  - `description: Optional[str]`

    Object description.

  - `expected_body: Optional[str]`

    A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.

  - `expected_codes: Optional[str]`

    The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.

  - `follow_redirects: Optional[bool]`

    Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.

  - `header: Optional[Dict[str, List[str]]]`

    The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.

  - `interval: Optional[int]`

    The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.

  - `method: Optional[str]`

    The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.

  - `modified_on: Optional[str]`

  - `path: Optional[str]`

    The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.

  - `port: Optional[int]`

    The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).

  - `probe_zone: Optional[str]`

    Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.

  - `retries: Optional[int]`

    The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.

  - `timeout: Optional[int]`

    The timeout (in seconds) before marking the health check as failed.

  - `type: Optional[Literal["http", "https", "tcp", 3 more]]`

    The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'.

    - `"http"`

    - `"https"`

    - `"tcp"`

    - `"udp_icmp"`

    - `"icmp_ping"`

    - `"smtp"`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
page = client.load_balancers.monitors.list(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
page = page.result[0]
print(page.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
      "allow_insecure": true,
      "consecutive_down": 0,
      "consecutive_up": 0,
      "created_on": "2014-01-01T05:20:00.12345Z",
      "description": "Login page monitor",
      "expected_body": "alive",
      "expected_codes": "2xx",
      "follow_redirects": true,
      "header": {
        "Host": [
          "example.com"
        ],
        "X-App-ID": [
          "abc123"
        ]
      },
      "interval": 0,
      "method": "GET",
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "path": "/health",
      "port": 0,
      "probe_zone": "example.com",
      "retries": 0,
      "timeout": 0,
      "type": "https"
    }
  ],
  "success": true,
  "result_info": {
    "count": 20,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}
```

## Monitor Details

`load_balancers.monitors.get(strmonitor_id, MonitorGetParams**kwargs)  -> Monitor`

**get** `/accounts/{account_id}/load_balancers/monitors/{monitor_id}`

List a single configured monitor for an account.

### Parameters

- `account_id: str`

  Identifier.

- `monitor_id: str`

### Returns

- `class Monitor: …`

  - `id: Optional[str]`

  - `allow_insecure: Optional[bool]`

    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.

  - `consecutive_down: Optional[int]`

    To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.

  - `consecutive_up: Optional[int]`

    To be marked healthy the monitored origin must pass this healthcheck N consecutive times.

  - `created_on: Optional[str]`

  - `description: Optional[str]`

    Object description.

  - `expected_body: Optional[str]`

    A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.

  - `expected_codes: Optional[str]`

    The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.

  - `follow_redirects: Optional[bool]`

    Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.

  - `header: Optional[Dict[str, List[str]]]`

    The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.

  - `interval: Optional[int]`

    The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.

  - `method: Optional[str]`

    The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.

  - `modified_on: Optional[str]`

  - `path: Optional[str]`

    The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.

  - `port: Optional[int]`

    The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).

  - `probe_zone: Optional[str]`

    Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.

  - `retries: Optional[int]`

    The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.

  - `timeout: Optional[int]`

    The timeout (in seconds) before marking the health check as failed.

  - `type: Optional[Literal["http", "https", "tcp", 3 more]]`

    The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'.

    - `"http"`

    - `"https"`

    - `"tcp"`

    - `"udp_icmp"`

    - `"icmp_ping"`

    - `"smtp"`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
monitor = client.load_balancers.monitors.get(
    monitor_id="f1aba936b94213e5b8dca0c0dbf1f9cc",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(monitor.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "allow_insecure": true,
    "consecutive_down": 0,
    "consecutive_up": 0,
    "created_on": "2014-01-01T05:20:00.12345Z",
    "description": "Login page monitor",
    "expected_body": "alive",
    "expected_codes": "2xx",
    "follow_redirects": true,
    "header": {
      "Host": [
        "example.com"
      ],
      "X-App-ID": [
        "abc123"
      ]
    },
    "interval": 0,
    "method": "GET",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "path": "/health",
    "port": 0,
    "probe_zone": "example.com",
    "retries": 0,
    "timeout": 0,
    "type": "https"
  },
  "success": true
}
```

## Create Monitor

`load_balancers.monitors.create(MonitorCreateParams**kwargs)  -> Monitor`

**post** `/accounts/{account_id}/load_balancers/monitors`

Create a configured monitor.

### Parameters

- `account_id: str`

  Identifier.

- `allow_insecure: Optional[bool]`

  Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.

- `consecutive_down: Optional[int]`

  To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.

- `consecutive_up: Optional[int]`

  To be marked healthy the monitored origin must pass this healthcheck N consecutive times.

- `description: Optional[str]`

  Object description.

- `expected_body: Optional[str]`

  A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.

- `expected_codes: Optional[str]`

  The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.

- `follow_redirects: Optional[bool]`

  Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.

- `header: Optional[Dict[str, SequenceNotStr[str]]]`

  The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.

- `interval: Optional[int]`

  The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.

- `method: Optional[str]`

  The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.

- `path: Optional[str]`

  The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.

- `port: Optional[int]`

  The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).

- `probe_zone: Optional[str]`

  Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.

- `retries: Optional[int]`

  The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.

- `load_balancer_monitor_timeout: Optional[int]`

  The timeout (in seconds) before marking the health check as failed.

- `type: Optional[Literal["http", "https", "tcp", 3 more]]`

  The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'.

  - `"http"`

  - `"https"`

  - `"tcp"`

  - `"udp_icmp"`

  - `"icmp_ping"`

  - `"smtp"`

### Returns

- `class Monitor: …`

  - `id: Optional[str]`

  - `allow_insecure: Optional[bool]`

    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.

  - `consecutive_down: Optional[int]`

    To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.

  - `consecutive_up: Optional[int]`

    To be marked healthy the monitored origin must pass this healthcheck N consecutive times.

  - `created_on: Optional[str]`

  - `description: Optional[str]`

    Object description.

  - `expected_body: Optional[str]`

    A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.

  - `expected_codes: Optional[str]`

    The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.

  - `follow_redirects: Optional[bool]`

    Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.

  - `header: Optional[Dict[str, List[str]]]`

    The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.

  - `interval: Optional[int]`

    The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.

  - `method: Optional[str]`

    The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.

  - `modified_on: Optional[str]`

  - `path: Optional[str]`

    The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.

  - `port: Optional[int]`

    The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).

  - `probe_zone: Optional[str]`

    Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.

  - `retries: Optional[int]`

    The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.

  - `timeout: Optional[int]`

    The timeout (in seconds) before marking the health check as failed.

  - `type: Optional[Literal["http", "https", "tcp", 3 more]]`

    The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'.

    - `"http"`

    - `"https"`

    - `"tcp"`

    - `"udp_icmp"`

    - `"icmp_ping"`

    - `"smtp"`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
monitor = client.load_balancers.monitors.create(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(monitor.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "allow_insecure": true,
    "consecutive_down": 0,
    "consecutive_up": 0,
    "created_on": "2014-01-01T05:20:00.12345Z",
    "description": "Login page monitor",
    "expected_body": "alive",
    "expected_codes": "2xx",
    "follow_redirects": true,
    "header": {
      "Host": [
        "example.com"
      ],
      "X-App-ID": [
        "abc123"
      ]
    },
    "interval": 0,
    "method": "GET",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "path": "/health",
    "port": 0,
    "probe_zone": "example.com",
    "retries": 0,
    "timeout": 0,
    "type": "https"
  },
  "success": true
}
```

## Update Monitor

`load_balancers.monitors.update(strmonitor_id, MonitorUpdateParams**kwargs)  -> Monitor`

**put** `/accounts/{account_id}/load_balancers/monitors/{monitor_id}`

Modify a configured monitor.

### Parameters

- `account_id: str`

  Identifier.

- `monitor_id: str`

- `allow_insecure: Optional[bool]`

  Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.

- `consecutive_down: Optional[int]`

  To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.

- `consecutive_up: Optional[int]`

  To be marked healthy the monitored origin must pass this healthcheck N consecutive times.

- `description: Optional[str]`

  Object description.

- `expected_body: Optional[str]`

  A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.

- `expected_codes: Optional[str]`

  The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.

- `follow_redirects: Optional[bool]`

  Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.

- `header: Optional[Dict[str, SequenceNotStr[str]]]`

  The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.

- `interval: Optional[int]`

  The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.

- `method: Optional[str]`

  The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.

- `path: Optional[str]`

  The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.

- `port: Optional[int]`

  The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).

- `probe_zone: Optional[str]`

  Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.

- `retries: Optional[int]`

  The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.

- `load_balancer_monitor_timeout: Optional[int]`

  The timeout (in seconds) before marking the health check as failed.

- `type: Optional[Literal["http", "https", "tcp", 3 more]]`

  The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'.

  - `"http"`

  - `"https"`

  - `"tcp"`

  - `"udp_icmp"`

  - `"icmp_ping"`

  - `"smtp"`

### Returns

- `class Monitor: …`

  - `id: Optional[str]`

  - `allow_insecure: Optional[bool]`

    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.

  - `consecutive_down: Optional[int]`

    To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.

  - `consecutive_up: Optional[int]`

    To be marked healthy the monitored origin must pass this healthcheck N consecutive times.

  - `created_on: Optional[str]`

  - `description: Optional[str]`

    Object description.

  - `expected_body: Optional[str]`

    A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.

  - `expected_codes: Optional[str]`

    The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.

  - `follow_redirects: Optional[bool]`

    Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.

  - `header: Optional[Dict[str, List[str]]]`

    The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.

  - `interval: Optional[int]`

    The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.

  - `method: Optional[str]`

    The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.

  - `modified_on: Optional[str]`

  - `path: Optional[str]`

    The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.

  - `port: Optional[int]`

    The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).

  - `probe_zone: Optional[str]`

    Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.

  - `retries: Optional[int]`

    The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.

  - `timeout: Optional[int]`

    The timeout (in seconds) before marking the health check as failed.

  - `type: Optional[Literal["http", "https", "tcp", 3 more]]`

    The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'.

    - `"http"`

    - `"https"`

    - `"tcp"`

    - `"udp_icmp"`

    - `"icmp_ping"`

    - `"smtp"`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
monitor = client.load_balancers.monitors.update(
    monitor_id="f1aba936b94213e5b8dca0c0dbf1f9cc",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(monitor.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "allow_insecure": true,
    "consecutive_down": 0,
    "consecutive_up": 0,
    "created_on": "2014-01-01T05:20:00.12345Z",
    "description": "Login page monitor",
    "expected_body": "alive",
    "expected_codes": "2xx",
    "follow_redirects": true,
    "header": {
      "Host": [
        "example.com"
      ],
      "X-App-ID": [
        "abc123"
      ]
    },
    "interval": 0,
    "method": "GET",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "path": "/health",
    "port": 0,
    "probe_zone": "example.com",
    "retries": 0,
    "timeout": 0,
    "type": "https"
  },
  "success": true
}
```

## Patch Monitor

`load_balancers.monitors.edit(strmonitor_id, MonitorEditParams**kwargs)  -> Monitor`

**patch** `/accounts/{account_id}/load_balancers/monitors/{monitor_id}`

Apply changes to an existing monitor, overwriting the supplied properties.

### Parameters

- `account_id: str`

  Identifier.

- `monitor_id: str`

- `allow_insecure: Optional[bool]`

  Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.

- `consecutive_down: Optional[int]`

  To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.

- `consecutive_up: Optional[int]`

  To be marked healthy the monitored origin must pass this healthcheck N consecutive times.

- `description: Optional[str]`

  Object description.

- `expected_body: Optional[str]`

  A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.

- `expected_codes: Optional[str]`

  The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.

- `follow_redirects: Optional[bool]`

  Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.

- `header: Optional[Dict[str, SequenceNotStr[str]]]`

  The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.

- `interval: Optional[int]`

  The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.

- `method: Optional[str]`

  The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.

- `path: Optional[str]`

  The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.

- `port: Optional[int]`

  The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).

- `probe_zone: Optional[str]`

  Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.

- `retries: Optional[int]`

  The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.

- `load_balancer_monitor_timeout: Optional[int]`

  The timeout (in seconds) before marking the health check as failed.

- `type: Optional[Literal["http", "https", "tcp", 3 more]]`

  The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'.

  - `"http"`

  - `"https"`

  - `"tcp"`

  - `"udp_icmp"`

  - `"icmp_ping"`

  - `"smtp"`

### Returns

- `class Monitor: …`

  - `id: Optional[str]`

  - `allow_insecure: Optional[bool]`

    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.

  - `consecutive_down: Optional[int]`

    To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.

  - `consecutive_up: Optional[int]`

    To be marked healthy the monitored origin must pass this healthcheck N consecutive times.

  - `created_on: Optional[str]`

  - `description: Optional[str]`

    Object description.

  - `expected_body: Optional[str]`

    A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.

  - `expected_codes: Optional[str]`

    The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.

  - `follow_redirects: Optional[bool]`

    Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.

  - `header: Optional[Dict[str, List[str]]]`

    The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.

  - `interval: Optional[int]`

    The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.

  - `method: Optional[str]`

    The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.

  - `modified_on: Optional[str]`

  - `path: Optional[str]`

    The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.

  - `port: Optional[int]`

    The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).

  - `probe_zone: Optional[str]`

    Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.

  - `retries: Optional[int]`

    The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.

  - `timeout: Optional[int]`

    The timeout (in seconds) before marking the health check as failed.

  - `type: Optional[Literal["http", "https", "tcp", 3 more]]`

    The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'.

    - `"http"`

    - `"https"`

    - `"tcp"`

    - `"udp_icmp"`

    - `"icmp_ping"`

    - `"smtp"`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
monitor = client.load_balancers.monitors.edit(
    monitor_id="f1aba936b94213e5b8dca0c0dbf1f9cc",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(monitor.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "allow_insecure": true,
    "consecutive_down": 0,
    "consecutive_up": 0,
    "created_on": "2014-01-01T05:20:00.12345Z",
    "description": "Login page monitor",
    "expected_body": "alive",
    "expected_codes": "2xx",
    "follow_redirects": true,
    "header": {
      "Host": [
        "example.com"
      ],
      "X-App-ID": [
        "abc123"
      ]
    },
    "interval": 0,
    "method": "GET",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "path": "/health",
    "port": 0,
    "probe_zone": "example.com",
    "retries": 0,
    "timeout": 0,
    "type": "https"
  },
  "success": true
}
```

## Delete Monitor

`load_balancers.monitors.delete(strmonitor_id, MonitorDeleteParams**kwargs)  -> MonitorDeleteResponse`

**delete** `/accounts/{account_id}/load_balancers/monitors/{monitor_id}`

Delete a configured monitor.

### Parameters

- `account_id: str`

  Identifier.

- `monitor_id: str`

### Returns

- `class MonitorDeleteResponse: …`

  - `id: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
monitor = client.load_balancers.monitors.delete(
    monitor_id="f1aba936b94213e5b8dca0c0dbf1f9cc",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(monitor.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "f1aba936b94213e5b8dca0c0dbf1f9cc"
  },
  "success": true
}
```

## Domain Types

### Monitor

- `class Monitor: …`

  - `id: Optional[str]`

  - `allow_insecure: Optional[bool]`

    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.

  - `consecutive_down: Optional[int]`

    To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.

  - `consecutive_up: Optional[int]`

    To be marked healthy the monitored origin must pass this healthcheck N consecutive times.

  - `created_on: Optional[str]`

  - `description: Optional[str]`

    Object description.

  - `expected_body: Optional[str]`

    A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.

  - `expected_codes: Optional[str]`

    The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.

  - `follow_redirects: Optional[bool]`

    Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.

  - `header: Optional[Dict[str, List[str]]]`

    The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.

  - `interval: Optional[int]`

    The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.

  - `method: Optional[str]`

    The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.

  - `modified_on: Optional[str]`

  - `path: Optional[str]`

    The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.

  - `port: Optional[int]`

    The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).

  - `probe_zone: Optional[str]`

    Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.

  - `retries: Optional[int]`

    The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.

  - `timeout: Optional[int]`

    The timeout (in seconds) before marking the health check as failed.

  - `type: Optional[Literal["http", "https", "tcp", 3 more]]`

    The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'.

    - `"http"`

    - `"https"`

    - `"tcp"`

    - `"udp_icmp"`

    - `"icmp_ping"`

    - `"smtp"`

### Monitor Delete Response

- `class MonitorDeleteResponse: …`

  - `id: Optional[str]`

# Previews

## Preview Monitor

`load_balancers.monitors.previews.create(strmonitor_id, PreviewCreateParams**kwargs)  -> PreviewCreateResponse`

**post** `/accounts/{account_id}/load_balancers/monitors/{monitor_id}/preview`

Preview pools using the specified monitor with provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.

### Parameters

- `account_id: str`

  Identifier.

- `monitor_id: str`

- `allow_insecure: Optional[bool]`

  Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.

- `consecutive_down: Optional[int]`

  To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.

- `consecutive_up: Optional[int]`

  To be marked healthy the monitored origin must pass this healthcheck N consecutive times.

- `description: Optional[str]`

  Object description.

- `expected_body: Optional[str]`

  A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.

- `expected_codes: Optional[str]`

  The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.

- `follow_redirects: Optional[bool]`

  Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.

- `header: Optional[Dict[str, SequenceNotStr[str]]]`

  The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.

- `interval: Optional[int]`

  The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.

- `method: Optional[str]`

  The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.

- `path: Optional[str]`

  The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.

- `port: Optional[int]`

  The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).

- `probe_zone: Optional[str]`

  Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.

- `retries: Optional[int]`

  The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.

- `load_balancer_monitor_timeout: Optional[int]`

  The timeout (in seconds) before marking the health check as failed.

- `type: Optional[Literal["http", "https", "tcp", 3 more]]`

  The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'.

  - `"http"`

  - `"https"`

  - `"tcp"`

  - `"udp_icmp"`

  - `"icmp_ping"`

  - `"smtp"`

### Returns

- `class PreviewCreateResponse: …`

  - `pools: Optional[Dict[str, str]]`

    Monitored pool IDs mapped to their respective names.

  - `preview_id: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
preview = client.load_balancers.monitors.previews.create(
    monitor_id="f1aba936b94213e5b8dca0c0dbf1f9cc",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(preview.preview_id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "pools": {
      "abwlnp5jbqn45ecgxd03erbgtxtqai0d": "WNAM Datacenter",
      "ve8h9lrcip5n5bbga9yqmdws28ay5d0l": "EEU Datacenter"
    },
    "preview_id": "f1aba936b94213e5b8dca0c0dbf1f9cc"
  },
  "success": true
}
```

## Domain Types

### Preview Create Response

- `class PreviewCreateResponse: …`

  - `pools: Optional[Dict[str, str]]`

    Monitored pool IDs mapped to their respective names.

  - `preview_id: Optional[str]`

# References

## List Monitor References

`load_balancers.monitors.references.get(strmonitor_id, ReferenceGetParams**kwargs)  -> SyncSinglePage[ReferenceGetResponse]`

**get** `/accounts/{account_id}/load_balancers/monitors/{monitor_id}/references`

Get the list of resources that reference the provided monitor.

### Parameters

- `account_id: str`

  Identifier.

- `monitor_id: str`

### Returns

- `class ReferenceGetResponse: …`

  - `reference_type: Optional[Literal["*", "referral", "referrer"]]`

    - `"*"`

    - `"referral"`

    - `"referrer"`

  - `resource_id: Optional[str]`

  - `resource_name: Optional[str]`

  - `resource_type: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
page = client.load_balancers.monitors.references.get(
    monitor_id="f1aba936b94213e5b8dca0c0dbf1f9cc",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
page = page.result[0]
print(page.resource_id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "reference_type": "referrer",
      "resource_id": "17b5962d775c646f3f9725cbc7a53df4",
      "resource_name": "primary-dc-1",
      "resource_type": "pool"
    }
  ],
  "success": true
}
```

## Domain Types

### Reference Get Response

- `class ReferenceGetResponse: …`

  - `reference_type: Optional[Literal["*", "referral", "referrer"]]`

    - `"*"`

    - `"referral"`

    - `"referrer"`

  - `resource_id: Optional[str]`

  - `resource_name: Optional[str]`

  - `resource_type: Optional[str]`

# Monitor Groups

## List Monitor Groups

`load_balancers.monitor_groups.list(MonitorGroupListParams**kwargs)  -> SyncSinglePage[MonitorGroup]`

**get** `/accounts/{account_id}/load_balancers/monitor_groups`

List configured monitor groups.

### Parameters

- `account_id: str`

  Identifier.

### Returns

- `class MonitorGroup: …`

  - `id: str`

    The ID of the Monitor Group to use for checking the health of origins within this pool.

  - `description: str`

    A short description of the monitor group

  - `members: List[Member]`

    List of monitors in this group

    - `enabled: bool`

      Whether this monitor is enabled in the group

    - `monitor_id: str`

      The ID of the Monitor to use for checking the health of origins within this pool.

    - `monitoring_only: bool`

      Whether this monitor is used for monitoring only (does not affect pool health)

    - `must_be_healthy: bool`

      Whether this monitor must be healthy for the pool to be considered healthy

    - `created_at: Optional[datetime]`

      The timestamp of when the monitor was added to the group

    - `updated_at: Optional[datetime]`

      The timestamp of when the monitor group member was last updated

  - `created_at: Optional[datetime]`

    The timestamp of when the monitor group was created

  - `updated_at: Optional[datetime]`

    The timestamp of when the monitor group was last updated

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
page = client.load_balancers.monitor_groups.list(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
page = page.result[0]
print(page.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "id",
      "description": "Primary datacenter monitors",
      "members": [
        {
          "enabled": true,
          "monitor_id": "monitor_id",
          "monitoring_only": false,
          "must_be_healthy": true,
          "created_at": "2014-01-01T05:20:00.12345Z",
          "updated_at": "2014-01-01T05:20:00.12345Z"
        }
      ],
      "created_at": "2014-01-01T05:20:00.12345Z",
      "updated_at": "2014-01-01T05:20:00.12345Z"
    }
  ],
  "success": true,
  "result_info": {
    "count": 20,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}
```

## Monitor Group Details

`load_balancers.monitor_groups.get(strmonitor_group_id, MonitorGroupGetParams**kwargs)  -> MonitorGroup`

**get** `/accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id}`

Fetch a single configured monitor group.

### Parameters

- `account_id: str`

  Identifier.

- `monitor_group_id: str`

### Returns

- `class MonitorGroup: …`

  - `id: str`

    The ID of the Monitor Group to use for checking the health of origins within this pool.

  - `description: str`

    A short description of the monitor group

  - `members: List[Member]`

    List of monitors in this group

    - `enabled: bool`

      Whether this monitor is enabled in the group

    - `monitor_id: str`

      The ID of the Monitor to use for checking the health of origins within this pool.

    - `monitoring_only: bool`

      Whether this monitor is used for monitoring only (does not affect pool health)

    - `must_be_healthy: bool`

      Whether this monitor must be healthy for the pool to be considered healthy

    - `created_at: Optional[datetime]`

      The timestamp of when the monitor was added to the group

    - `updated_at: Optional[datetime]`

      The timestamp of when the monitor group member was last updated

  - `created_at: Optional[datetime]`

    The timestamp of when the monitor group was created

  - `updated_at: Optional[datetime]`

    The timestamp of when the monitor group was last updated

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
monitor_group = client.load_balancers.monitor_groups.get(
    monitor_group_id="17b5962d775c646f3f9725cbc7a53df4",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(monitor_group.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "id",
    "description": "Primary datacenter monitors",
    "members": [
      {
        "enabled": true,
        "monitor_id": "monitor_id",
        "monitoring_only": false,
        "must_be_healthy": true,
        "created_at": "2014-01-01T05:20:00.12345Z",
        "updated_at": "2014-01-01T05:20:00.12345Z"
      }
    ],
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z"
  },
  "success": true
}
```

## Create Monitor Group

`load_balancers.monitor_groups.create(MonitorGroupCreateParams**kwargs)  -> MonitorGroup`

**post** `/accounts/{account_id}/load_balancers/monitor_groups`

Create a new monitor group.

### Parameters

- `account_id: str`

  Identifier.

- `id: str`

  The ID of the Monitor Group to use for checking the health of origins within this pool.

- `description: str`

  A short description of the monitor group

- `members: Iterable[Member]`

  List of monitors in this group

  - `enabled: bool`

    Whether this monitor is enabled in the group

  - `monitor_id: str`

    The ID of the Monitor to use for checking the health of origins within this pool.

  - `monitoring_only: bool`

    Whether this monitor is used for monitoring only (does not affect pool health)

  - `must_be_healthy: bool`

    Whether this monitor must be healthy for the pool to be considered healthy

  - `created_at: Optional[Union[str, datetime]]`

    The timestamp of when the monitor was added to the group

  - `updated_at: Optional[Union[str, datetime]]`

    The timestamp of when the monitor group member was last updated

### Returns

- `class MonitorGroup: …`

  - `id: str`

    The ID of the Monitor Group to use for checking the health of origins within this pool.

  - `description: str`

    A short description of the monitor group

  - `members: List[Member]`

    List of monitors in this group

    - `enabled: bool`

      Whether this monitor is enabled in the group

    - `monitor_id: str`

      The ID of the Monitor to use for checking the health of origins within this pool.

    - `monitoring_only: bool`

      Whether this monitor is used for monitoring only (does not affect pool health)

    - `must_be_healthy: bool`

      Whether this monitor must be healthy for the pool to be considered healthy

    - `created_at: Optional[datetime]`

      The timestamp of when the monitor was added to the group

    - `updated_at: Optional[datetime]`

      The timestamp of when the monitor group member was last updated

  - `created_at: Optional[datetime]`

    The timestamp of when the monitor group was created

  - `updated_at: Optional[datetime]`

    The timestamp of when the monitor group was last updated

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
monitor_group = client.load_balancers.monitor_groups.create(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    id="id",
    description="Primary datacenter monitors",
    members=[{
        "enabled": True,
        "monitor_id": "monitor_id",
        "monitoring_only": False,
        "must_be_healthy": True,
    }],
)
print(monitor_group.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "id",
    "description": "Primary datacenter monitors",
    "members": [
      {
        "enabled": true,
        "monitor_id": "monitor_id",
        "monitoring_only": false,
        "must_be_healthy": true,
        "created_at": "2014-01-01T05:20:00.12345Z",
        "updated_at": "2014-01-01T05:20:00.12345Z"
      }
    ],
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z"
  },
  "success": true
}
```

## Update Monitor Group

`load_balancers.monitor_groups.update(strmonitor_group_id, MonitorGroupUpdateParams**kwargs)  -> MonitorGroup`

**put** `/accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id}`

Modify a configured monitor group.

### Parameters

- `account_id: str`

  Identifier.

- `monitor_group_id: str`

- `id: str`

  The ID of the Monitor Group to use for checking the health of origins within this pool.

- `description: str`

  A short description of the monitor group

- `members: Iterable[Member]`

  List of monitors in this group

  - `enabled: bool`

    Whether this monitor is enabled in the group

  - `monitor_id: str`

    The ID of the Monitor to use for checking the health of origins within this pool.

  - `monitoring_only: bool`

    Whether this monitor is used for monitoring only (does not affect pool health)

  - `must_be_healthy: bool`

    Whether this monitor must be healthy for the pool to be considered healthy

  - `created_at: Optional[Union[str, datetime]]`

    The timestamp of when the monitor was added to the group

  - `updated_at: Optional[Union[str, datetime]]`

    The timestamp of when the monitor group member was last updated

### Returns

- `class MonitorGroup: …`

  - `id: str`

    The ID of the Monitor Group to use for checking the health of origins within this pool.

  - `description: str`

    A short description of the monitor group

  - `members: List[Member]`

    List of monitors in this group

    - `enabled: bool`

      Whether this monitor is enabled in the group

    - `monitor_id: str`

      The ID of the Monitor to use for checking the health of origins within this pool.

    - `monitoring_only: bool`

      Whether this monitor is used for monitoring only (does not affect pool health)

    - `must_be_healthy: bool`

      Whether this monitor must be healthy for the pool to be considered healthy

    - `created_at: Optional[datetime]`

      The timestamp of when the monitor was added to the group

    - `updated_at: Optional[datetime]`

      The timestamp of when the monitor group member was last updated

  - `created_at: Optional[datetime]`

    The timestamp of when the monitor group was created

  - `updated_at: Optional[datetime]`

    The timestamp of when the monitor group was last updated

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
monitor_group = client.load_balancers.monitor_groups.update(
    monitor_group_id="17b5962d775c646f3f9725cbc7a53df4",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    id="id",
    description="Primary datacenter monitors",
    members=[{
        "enabled": True,
        "monitor_id": "monitor_id",
        "monitoring_only": False,
        "must_be_healthy": True,
    }],
)
print(monitor_group.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "id",
    "description": "Primary datacenter monitors",
    "members": [
      {
        "enabled": true,
        "monitor_id": "monitor_id",
        "monitoring_only": false,
        "must_be_healthy": true,
        "created_at": "2014-01-01T05:20:00.12345Z",
        "updated_at": "2014-01-01T05:20:00.12345Z"
      }
    ],
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z"
  },
  "success": true
}
```

## Patch Monitor Group

`load_balancers.monitor_groups.edit(strmonitor_group_id, MonitorGroupEditParams**kwargs)  -> MonitorGroup`

**patch** `/accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id}`

Apply changes to an existing monitor group, overwriting the supplied properties.

### Parameters

- `account_id: str`

  Identifier.

- `monitor_group_id: str`

- `id: str`

  The ID of the Monitor Group to use for checking the health of origins within this pool.

- `description: str`

  A short description of the monitor group

- `members: Iterable[Member]`

  List of monitors in this group

  - `enabled: bool`

    Whether this monitor is enabled in the group

  - `monitor_id: str`

    The ID of the Monitor to use for checking the health of origins within this pool.

  - `monitoring_only: bool`

    Whether this monitor is used for monitoring only (does not affect pool health)

  - `must_be_healthy: bool`

    Whether this monitor must be healthy for the pool to be considered healthy

  - `created_at: Optional[Union[str, datetime]]`

    The timestamp of when the monitor was added to the group

  - `updated_at: Optional[Union[str, datetime]]`

    The timestamp of when the monitor group member was last updated

### Returns

- `class MonitorGroup: …`

  - `id: str`

    The ID of the Monitor Group to use for checking the health of origins within this pool.

  - `description: str`

    A short description of the monitor group

  - `members: List[Member]`

    List of monitors in this group

    - `enabled: bool`

      Whether this monitor is enabled in the group

    - `monitor_id: str`

      The ID of the Monitor to use for checking the health of origins within this pool.

    - `monitoring_only: bool`

      Whether this monitor is used for monitoring only (does not affect pool health)

    - `must_be_healthy: bool`

      Whether this monitor must be healthy for the pool to be considered healthy

    - `created_at: Optional[datetime]`

      The timestamp of when the monitor was added to the group

    - `updated_at: Optional[datetime]`

      The timestamp of when the monitor group member was last updated

  - `created_at: Optional[datetime]`

    The timestamp of when the monitor group was created

  - `updated_at: Optional[datetime]`

    The timestamp of when the monitor group was last updated

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
monitor_group = client.load_balancers.monitor_groups.edit(
    monitor_group_id="17b5962d775c646f3f9725cbc7a53df4",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    id="id",
    description="Primary datacenter monitors",
    members=[{
        "enabled": True,
        "monitor_id": "monitor_id",
        "monitoring_only": False,
        "must_be_healthy": True,
    }],
)
print(monitor_group.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "id",
    "description": "Primary datacenter monitors",
    "members": [
      {
        "enabled": true,
        "monitor_id": "monitor_id",
        "monitoring_only": false,
        "must_be_healthy": true,
        "created_at": "2014-01-01T05:20:00.12345Z",
        "updated_at": "2014-01-01T05:20:00.12345Z"
      }
    ],
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z"
  },
  "success": true
}
```

## Delete Monitor Group

`load_balancers.monitor_groups.delete(strmonitor_group_id, MonitorGroupDeleteParams**kwargs)  -> MonitorGroup`

**delete** `/accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id}`

Delete a configured monitor group.

### Parameters

- `account_id: str`

  Identifier.

- `monitor_group_id: str`

### Returns

- `class MonitorGroup: …`

  - `id: str`

    The ID of the Monitor Group to use for checking the health of origins within this pool.

  - `description: str`

    A short description of the monitor group

  - `members: List[Member]`

    List of monitors in this group

    - `enabled: bool`

      Whether this monitor is enabled in the group

    - `monitor_id: str`

      The ID of the Monitor to use for checking the health of origins within this pool.

    - `monitoring_only: bool`

      Whether this monitor is used for monitoring only (does not affect pool health)

    - `must_be_healthy: bool`

      Whether this monitor must be healthy for the pool to be considered healthy

    - `created_at: Optional[datetime]`

      The timestamp of when the monitor was added to the group

    - `updated_at: Optional[datetime]`

      The timestamp of when the monitor group member was last updated

  - `created_at: Optional[datetime]`

    The timestamp of when the monitor group was created

  - `updated_at: Optional[datetime]`

    The timestamp of when the monitor group was last updated

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
monitor_group = client.load_balancers.monitor_groups.delete(
    monitor_group_id="17b5962d775c646f3f9725cbc7a53df4",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(monitor_group.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "id",
    "description": "Primary datacenter monitors",
    "members": [
      {
        "enabled": true,
        "monitor_id": "monitor_id",
        "monitoring_only": false,
        "must_be_healthy": true,
        "created_at": "2014-01-01T05:20:00.12345Z",
        "updated_at": "2014-01-01T05:20:00.12345Z"
      }
    ],
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z"
  },
  "success": true
}
```

## Domain Types

### Monitor Group

- `class MonitorGroup: …`

  - `id: str`

    The ID of the Monitor Group to use for checking the health of origins within this pool.

  - `description: str`

    A short description of the monitor group

  - `members: List[Member]`

    List of monitors in this group

    - `enabled: bool`

      Whether this monitor is enabled in the group

    - `monitor_id: str`

      The ID of the Monitor to use for checking the health of origins within this pool.

    - `monitoring_only: bool`

      Whether this monitor is used for monitoring only (does not affect pool health)

    - `must_be_healthy: bool`

      Whether this monitor must be healthy for the pool to be considered healthy

    - `created_at: Optional[datetime]`

      The timestamp of when the monitor was added to the group

    - `updated_at: Optional[datetime]`

      The timestamp of when the monitor group member was last updated

  - `created_at: Optional[datetime]`

    The timestamp of when the monitor group was created

  - `updated_at: Optional[datetime]`

    The timestamp of when the monitor group was last updated

# Pools

## List Pools

`load_balancers.pools.list(PoolListParams**kwargs)  -> SyncSinglePage[Pool]`

**get** `/accounts/{account_id}/load_balancers/pools`

List configured pools.

### Parameters

- `account_id: str`

  Identifier.

- `monitor: Optional[str]`

  The ID of the Monitor to use for checking the health of origins within this pool.

### Returns

- `class Pool: …`

  - `id: Optional[str]`

  - `check_regions: Optional[List[CheckRegion]]`

    A list of regions from which to run health checks. Null means every Cloudflare data center.

    - `"WNAM"`

    - `"ENAM"`

    - `"WEU"`

    - `"EEU"`

    - `"NSAM"`

    - `"SSAM"`

    - `"OC"`

    - `"ME"`

    - `"NAF"`

    - `"SAF"`

    - `"SAS"`

    - `"SEAS"`

    - `"NEAS"`

    - `"ALL_REGIONS"`

  - `created_on: Optional[str]`

  - `description: Optional[str]`

    A human-readable description of the pool.

  - `disabled_at: Optional[datetime]`

    This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.

  - `enabled: Optional[bool]`

    Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).

  - `latitude: Optional[float]`

    The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.

  - `load_shedding: Optional[LoadShedding]`

    Configures load shedding policies and percentages for the pool.

    - `default_percent: Optional[float]`

      The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.

    - `default_policy: Optional[Literal["random", "hash"]]`

      The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs.

      - `"random"`

      - `"hash"`

    - `session_percent: Optional[float]`

      The percent of existing sessions to shed from the pool, according to the session policy.

    - `session_policy: Optional[Literal["hash"]]`

      Only the hash policy is supported for existing sessions (to avoid exponential decay).

      - `"hash"`

  - `longitude: Optional[float]`

    The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.

  - `minimum_origins: Optional[int]`

    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.

  - `modified_on: Optional[str]`

  - `monitor: Optional[str]`

    The ID of the Monitor to use for checking the health of origins within this pool.

  - `monitor_group: Optional[str]`

    The ID of the Monitor Group to use for checking the health of origins within this pool.

  - `name: Optional[str]`

    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.

  - `networks: Optional[List[str]]`

    List of networks where Load Balancer or Pool is enabled.

  - `notification_email: Optional[str]`

    This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.

  - `notification_filter: Optional[NotificationFilter]`

    Filter pool and origin health notifications by resource type or health status. Use null to reset.

    - `origin: Optional[FilterOptions]`

      Filter options for a particular resource type (pool or origin). Use null to reset.

      - `disable: Optional[bool]`

        If set true, disable notifications for this type of resource (pool or origin).

      - `healthy: Optional[bool]`

        If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).

    - `pool: Optional[FilterOptions]`

      Filter options for a particular resource type (pool or origin). Use null to reset.

  - `origin_steering: Optional[OriginSteering]`

    Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.

    - `policy: Optional[Literal["random", "hash", "least_outstanding_requests", "least_connections"]]`

      The type of origin steering policy to use.

      - `"random"`: Select an origin randomly.
      - `"hash"`: Select an origin by computing a hash over the CF-Connecting-IP address.
      - `"least_outstanding_requests"`: Select an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others.
      - `"least_connections"`: Select an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.

      - `"random"`

      - `"hash"`

      - `"least_outstanding_requests"`

      - `"least_connections"`

  - `origins: Optional[List[Origin]]`

    The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

    - `address: Optional[str]`

      The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set.

    - `disabled_at: Optional[datetime]`

      This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.

    - `enabled: Optional[bool]`

      Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.

    - `header: Optional[Header]`

      The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.

      - `host: Optional[List[Host]]`

        The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.

    - `name: Optional[str]`

      A human-identifiable name for the origin.

    - `port: Optional[int]`

      The port for upstream connections. A value of 0 means the default port for the protocol will be used.

    - `virtual_network_id: Optional[str]`

      The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.

    - `weight: Optional[float]`

      The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.

      - `origin_steering.policy="least_outstanding_requests"`: Use weight to scale the origin's outstanding requests.
      - `origin_steering.policy="least_connections"`: Use weight to scale the origin's open connections.

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
page = client.load_balancers.pools.list(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
page = page.result[0]
print(page.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "17b5962d775c646f3f9725cbc7a53df4",
      "check_regions": [
        "WEU",
        "ENAM"
      ],
      "created_on": "2014-01-01T05:20:00.12345Z",
      "description": "Primary data center - Provider XYZ",
      "disabled_at": "2019-12-27T18:11:19.117Z",
      "enabled": false,
      "latitude": 0,
      "load_shedding": {
        "default_percent": 0,
        "default_policy": "random",
        "session_percent": 0,
        "session_policy": "hash"
      },
      "longitude": 0,
      "minimum_origins": 0,
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "monitor": "monitor",
      "monitor_group": "monitor_group",
      "name": "primary-dc-1",
      "networks": [
        "string"
      ],
      "notification_email": "someone@example.com,sometwo@example.com",
      "notification_filter": {
        "origin": {
          "disable": true,
          "healthy": true
        },
        "pool": {
          "disable": true,
          "healthy": false
        }
      },
      "origin_steering": {
        "policy": "random"
      },
      "origins": [
        {
          "address": "0.0.0.0",
          "disabled_at": "2019-12-27T18:11:19.117Z",
          "enabled": true,
          "header": {
            "Host": [
              "example.com"
            ]
          },
          "name": "app-server-1",
          "port": 0,
          "virtual_network_id": "a5624d4e-044a-4ff0-b3e1-e2465353d4b4",
          "weight": 0.6
        }
      ]
    }
  ],
  "success": true,
  "result_info": {
    "count": 20,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}
```

## Pool Details

`load_balancers.pools.get(strpool_id, PoolGetParams**kwargs)  -> Pool`

**get** `/accounts/{account_id}/load_balancers/pools/{pool_id}`

Fetch a single configured pool.

### Parameters

- `account_id: str`

  Identifier.

- `pool_id: str`

### Returns

- `class Pool: …`

  - `id: Optional[str]`

  - `check_regions: Optional[List[CheckRegion]]`

    A list of regions from which to run health checks. Null means every Cloudflare data center.

    - `"WNAM"`

    - `"ENAM"`

    - `"WEU"`

    - `"EEU"`

    - `"NSAM"`

    - `"SSAM"`

    - `"OC"`

    - `"ME"`

    - `"NAF"`

    - `"SAF"`

    - `"SAS"`

    - `"SEAS"`

    - `"NEAS"`

    - `"ALL_REGIONS"`

  - `created_on: Optional[str]`

  - `description: Optional[str]`

    A human-readable description of the pool.

  - `disabled_at: Optional[datetime]`

    This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.

  - `enabled: Optional[bool]`

    Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).

  - `latitude: Optional[float]`

    The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.

  - `load_shedding: Optional[LoadShedding]`

    Configures load shedding policies and percentages for the pool.

    - `default_percent: Optional[float]`

      The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.

    - `default_policy: Optional[Literal["random", "hash"]]`

      The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs.

      - `"random"`

      - `"hash"`

    - `session_percent: Optional[float]`

      The percent of existing sessions to shed from the pool, according to the session policy.

    - `session_policy: Optional[Literal["hash"]]`

      Only the hash policy is supported for existing sessions (to avoid exponential decay).

      - `"hash"`

  - `longitude: Optional[float]`

    The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.

  - `minimum_origins: Optional[int]`

    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.

  - `modified_on: Optional[str]`

  - `monitor: Optional[str]`

    The ID of the Monitor to use for checking the health of origins within this pool.

  - `monitor_group: Optional[str]`

    The ID of the Monitor Group to use for checking the health of origins within this pool.

  - `name: Optional[str]`

    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.

  - `networks: Optional[List[str]]`

    List of networks where Load Balancer or Pool is enabled.

  - `notification_email: Optional[str]`

    This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.

  - `notification_filter: Optional[NotificationFilter]`

    Filter pool and origin health notifications by resource type or health status. Use null to reset.

    - `origin: Optional[FilterOptions]`

      Filter options for a particular resource type (pool or origin). Use null to reset.

      - `disable: Optional[bool]`

        If set true, disable notifications for this type of resource (pool or origin).

      - `healthy: Optional[bool]`

        If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).

    - `pool: Optional[FilterOptions]`

      Filter options for a particular resource type (pool or origin). Use null to reset.

  - `origin_steering: Optional[OriginSteering]`

    Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.

    - `policy: Optional[Literal["random", "hash", "least_outstanding_requests", "least_connections"]]`

      The type of origin steering policy to use.

      - `"random"`: Select an origin randomly.
      - `"hash"`: Select an origin by computing a hash over the CF-Connecting-IP address.
      - `"least_outstanding_requests"`: Select an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others.
      - `"least_connections"`: Select an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.

      - `"random"`

      - `"hash"`

      - `"least_outstanding_requests"`

      - `"least_connections"`

  - `origins: Optional[List[Origin]]`

    The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

    - `address: Optional[str]`

      The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set.

    - `disabled_at: Optional[datetime]`

      This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.

    - `enabled: Optional[bool]`

      Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.

    - `header: Optional[Header]`

      The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.

      - `host: Optional[List[Host]]`

        The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.

    - `name: Optional[str]`

      A human-identifiable name for the origin.

    - `port: Optional[int]`

      The port for upstream connections. A value of 0 means the default port for the protocol will be used.

    - `virtual_network_id: Optional[str]`

      The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.

    - `weight: Optional[float]`

      The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.

      - `origin_steering.policy="least_outstanding_requests"`: Use weight to scale the origin's outstanding requests.
      - `origin_steering.policy="least_connections"`: Use weight to scale the origin's open connections.

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
pool = client.load_balancers.pools.get(
    pool_id="17b5962d775c646f3f9725cbc7a53df4",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(pool.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "17b5962d775c646f3f9725cbc7a53df4",
    "check_regions": [
      "WEU",
      "ENAM"
    ],
    "created_on": "2014-01-01T05:20:00.12345Z",
    "description": "Primary data center - Provider XYZ",
    "disabled_at": "2019-12-27T18:11:19.117Z",
    "enabled": false,
    "latitude": 0,
    "load_shedding": {
      "default_percent": 0,
      "default_policy": "random",
      "session_percent": 0,
      "session_policy": "hash"
    },
    "longitude": 0,
    "minimum_origins": 0,
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "monitor": "monitor",
    "monitor_group": "monitor_group",
    "name": "primary-dc-1",
    "networks": [
      "string"
    ],
    "notification_email": "someone@example.com,sometwo@example.com",
    "notification_filter": {
      "origin": {
        "disable": true,
        "healthy": true
      },
      "pool": {
        "disable": true,
        "healthy": false
      }
    },
    "origin_steering": {
      "policy": "random"
    },
    "origins": [
      {
        "address": "0.0.0.0",
        "disabled_at": "2019-12-27T18:11:19.117Z",
        "enabled": true,
        "header": {
          "Host": [
            "example.com"
          ]
        },
        "name": "app-server-1",
        "port": 0,
        "virtual_network_id": "a5624d4e-044a-4ff0-b3e1-e2465353d4b4",
        "weight": 0.6
      }
    ]
  },
  "success": true
}
```

## Create Pool

`load_balancers.pools.create(PoolCreateParams**kwargs)  -> Pool`

**post** `/accounts/{account_id}/load_balancers/pools`

Create a new pool.

### Parameters

- `account_id: str`

  Identifier.

- `name: str`

  A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.

- `origins: Iterable[OriginParam]`

  The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

  - `address: Optional[str]`

    The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set.

  - `disabled_at: Optional[datetime]`

    This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.

  - `enabled: Optional[bool]`

    Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.

  - `header: Optional[Header]`

    The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.

    - `host: Optional[List[Host]]`

      The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.

  - `name: Optional[str]`

    A human-identifiable name for the origin.

  - `port: Optional[int]`

    The port for upstream connections. A value of 0 means the default port for the protocol will be used.

  - `virtual_network_id: Optional[str]`

    The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.

  - `weight: Optional[float]`

    The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.

    - `origin_steering.policy="least_outstanding_requests"`: Use weight to scale the origin's outstanding requests.
    - `origin_steering.policy="least_connections"`: Use weight to scale the origin's open connections.

- `description: Optional[str]`

  A human-readable description of the pool.

- `enabled: Optional[bool]`

  Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).

- `latitude: Optional[float]`

  The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.

- `load_shedding: Optional[LoadSheddingParam]`

  Configures load shedding policies and percentages for the pool.

  - `default_percent: Optional[float]`

    The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.

  - `default_policy: Optional[Literal["random", "hash"]]`

    The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs.

    - `"random"`

    - `"hash"`

  - `session_percent: Optional[float]`

    The percent of existing sessions to shed from the pool, according to the session policy.

  - `session_policy: Optional[Literal["hash"]]`

    Only the hash policy is supported for existing sessions (to avoid exponential decay).

    - `"hash"`

- `longitude: Optional[float]`

  The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.

- `minimum_origins: Optional[int]`

  The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.

- `monitor: Optional[str]`

  The ID of the Monitor to use for checking the health of origins within this pool.

- `monitor_group: Optional[str]`

  The ID of the Monitor Group to use for checking the health of origins within this pool.

- `notification_email: Optional[str]`

  This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.

- `notification_filter: Optional[NotificationFilterParam]`

  Filter pool and origin health notifications by resource type or health status. Use null to reset.

  - `origin: Optional[FilterOptions]`

    Filter options for a particular resource type (pool or origin). Use null to reset.

    - `disable: Optional[bool]`

      If set true, disable notifications for this type of resource (pool or origin).

    - `healthy: Optional[bool]`

      If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).

  - `pool: Optional[FilterOptions]`

    Filter options for a particular resource type (pool or origin). Use null to reset.

- `origin_steering: Optional[OriginSteeringParam]`

  Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.

  - `policy: Optional[Literal["random", "hash", "least_outstanding_requests", "least_connections"]]`

    The type of origin steering policy to use.

    - `"random"`: Select an origin randomly.
    - `"hash"`: Select an origin by computing a hash over the CF-Connecting-IP address.
    - `"least_outstanding_requests"`: Select an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others.
    - `"least_connections"`: Select an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.

    - `"random"`

    - `"hash"`

    - `"least_outstanding_requests"`

    - `"least_connections"`

### Returns

- `class Pool: …`

  - `id: Optional[str]`

  - `check_regions: Optional[List[CheckRegion]]`

    A list of regions from which to run health checks. Null means every Cloudflare data center.

    - `"WNAM"`

    - `"ENAM"`

    - `"WEU"`

    - `"EEU"`

    - `"NSAM"`

    - `"SSAM"`

    - `"OC"`

    - `"ME"`

    - `"NAF"`

    - `"SAF"`

    - `"SAS"`

    - `"SEAS"`

    - `"NEAS"`

    - `"ALL_REGIONS"`

  - `created_on: Optional[str]`

  - `description: Optional[str]`

    A human-readable description of the pool.

  - `disabled_at: Optional[datetime]`

    This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.

  - `enabled: Optional[bool]`

    Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).

  - `latitude: Optional[float]`

    The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.

  - `load_shedding: Optional[LoadShedding]`

    Configures load shedding policies and percentages for the pool.

    - `default_percent: Optional[float]`

      The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.

    - `default_policy: Optional[Literal["random", "hash"]]`

      The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs.

      - `"random"`

      - `"hash"`

    - `session_percent: Optional[float]`

      The percent of existing sessions to shed from the pool, according to the session policy.

    - `session_policy: Optional[Literal["hash"]]`

      Only the hash policy is supported for existing sessions (to avoid exponential decay).

      - `"hash"`

  - `longitude: Optional[float]`

    The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.

  - `minimum_origins: Optional[int]`

    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.

  - `modified_on: Optional[str]`

  - `monitor: Optional[str]`

    The ID of the Monitor to use for checking the health of origins within this pool.

  - `monitor_group: Optional[str]`

    The ID of the Monitor Group to use for checking the health of origins within this pool.

  - `name: Optional[str]`

    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.

  - `networks: Optional[List[str]]`

    List of networks where Load Balancer or Pool is enabled.

  - `notification_email: Optional[str]`

    This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.

  - `notification_filter: Optional[NotificationFilter]`

    Filter pool and origin health notifications by resource type or health status. Use null to reset.

    - `origin: Optional[FilterOptions]`

      Filter options for a particular resource type (pool or origin). Use null to reset.

      - `disable: Optional[bool]`

        If set true, disable notifications for this type of resource (pool or origin).

      - `healthy: Optional[bool]`

        If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).

    - `pool: Optional[FilterOptions]`

      Filter options for a particular resource type (pool or origin). Use null to reset.

  - `origin_steering: Optional[OriginSteering]`

    Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.

    - `policy: Optional[Literal["random", "hash", "least_outstanding_requests", "least_connections"]]`

      The type of origin steering policy to use.

      - `"random"`: Select an origin randomly.
      - `"hash"`: Select an origin by computing a hash over the CF-Connecting-IP address.
      - `"least_outstanding_requests"`: Select an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others.
      - `"least_connections"`: Select an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.

      - `"random"`

      - `"hash"`

      - `"least_outstanding_requests"`

      - `"least_connections"`

  - `origins: Optional[List[Origin]]`

    The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

    - `address: Optional[str]`

      The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set.

    - `disabled_at: Optional[datetime]`

      This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.

    - `enabled: Optional[bool]`

      Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.

    - `header: Optional[Header]`

      The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.

      - `host: Optional[List[Host]]`

        The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.

    - `name: Optional[str]`

      A human-identifiable name for the origin.

    - `port: Optional[int]`

      The port for upstream connections. A value of 0 means the default port for the protocol will be used.

    - `virtual_network_id: Optional[str]`

      The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.

    - `weight: Optional[float]`

      The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.

      - `origin_steering.policy="least_outstanding_requests"`: Use weight to scale the origin's outstanding requests.
      - `origin_steering.policy="least_connections"`: Use weight to scale the origin's open connections.

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
pool = client.load_balancers.pools.create(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    name="primary-dc-1",
    origins=[{}],
)
print(pool.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "17b5962d775c646f3f9725cbc7a53df4",
    "check_regions": [
      "WEU",
      "ENAM"
    ],
    "created_on": "2014-01-01T05:20:00.12345Z",
    "description": "Primary data center - Provider XYZ",
    "disabled_at": "2019-12-27T18:11:19.117Z",
    "enabled": false,
    "latitude": 0,
    "load_shedding": {
      "default_percent": 0,
      "default_policy": "random",
      "session_percent": 0,
      "session_policy": "hash"
    },
    "longitude": 0,
    "minimum_origins": 0,
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "monitor": "monitor",
    "monitor_group": "monitor_group",
    "name": "primary-dc-1",
    "networks": [
      "string"
    ],
    "notification_email": "someone@example.com,sometwo@example.com",
    "notification_filter": {
      "origin": {
        "disable": true,
        "healthy": true
      },
      "pool": {
        "disable": true,
        "healthy": false
      }
    },
    "origin_steering": {
      "policy": "random"
    },
    "origins": [
      {
        "address": "0.0.0.0",
        "disabled_at": "2019-12-27T18:11:19.117Z",
        "enabled": true,
        "header": {
          "Host": [
            "example.com"
          ]
        },
        "name": "app-server-1",
        "port": 0,
        "virtual_network_id": "a5624d4e-044a-4ff0-b3e1-e2465353d4b4",
        "weight": 0.6
      }
    ]
  },
  "success": true
}
```

## Update Pool

`load_balancers.pools.update(strpool_id, PoolUpdateParams**kwargs)  -> Pool`

**put** `/accounts/{account_id}/load_balancers/pools/{pool_id}`

Modify a configured pool.

### Parameters

- `account_id: str`

  Identifier.

- `pool_id: str`

- `name: str`

  A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.

- `origins: Iterable[OriginParam]`

  The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

  - `address: Optional[str]`

    The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set.

  - `disabled_at: Optional[datetime]`

    This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.

  - `enabled: Optional[bool]`

    Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.

  - `header: Optional[Header]`

    The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.

    - `host: Optional[List[Host]]`

      The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.

  - `name: Optional[str]`

    A human-identifiable name for the origin.

  - `port: Optional[int]`

    The port for upstream connections. A value of 0 means the default port for the protocol will be used.

  - `virtual_network_id: Optional[str]`

    The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.

  - `weight: Optional[float]`

    The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.

    - `origin_steering.policy="least_outstanding_requests"`: Use weight to scale the origin's outstanding requests.
    - `origin_steering.policy="least_connections"`: Use weight to scale the origin's open connections.

- `check_regions: Optional[List[CheckRegion]]`

  A list of regions from which to run health checks. Null means every Cloudflare data center.

  - `"WNAM"`

  - `"ENAM"`

  - `"WEU"`

  - `"EEU"`

  - `"NSAM"`

  - `"SSAM"`

  - `"OC"`

  - `"ME"`

  - `"NAF"`

  - `"SAF"`

  - `"SAS"`

  - `"SEAS"`

  - `"NEAS"`

  - `"ALL_REGIONS"`

- `description: Optional[str]`

  A human-readable description of the pool.

- `enabled: Optional[bool]`

  Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).

- `latitude: Optional[float]`

  The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.

- `load_shedding: Optional[LoadSheddingParam]`

  Configures load shedding policies and percentages for the pool.

  - `default_percent: Optional[float]`

    The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.

  - `default_policy: Optional[Literal["random", "hash"]]`

    The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs.

    - `"random"`

    - `"hash"`

  - `session_percent: Optional[float]`

    The percent of existing sessions to shed from the pool, according to the session policy.

  - `session_policy: Optional[Literal["hash"]]`

    Only the hash policy is supported for existing sessions (to avoid exponential decay).

    - `"hash"`

- `longitude: Optional[float]`

  The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.

- `minimum_origins: Optional[int]`

  The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.

- `monitor: Optional[str]`

  The ID of the Monitor to use for checking the health of origins within this pool.

- `monitor_group: Optional[str]`

  The ID of the Monitor Group to use for checking the health of origins within this pool.

- `notification_email: Optional[str]`

  This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.

- `notification_filter: Optional[NotificationFilterParam]`

  Filter pool and origin health notifications by resource type or health status. Use null to reset.

  - `origin: Optional[FilterOptions]`

    Filter options for a particular resource type (pool or origin). Use null to reset.

    - `disable: Optional[bool]`

      If set true, disable notifications for this type of resource (pool or origin).

    - `healthy: Optional[bool]`

      If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).

  - `pool: Optional[FilterOptions]`

    Filter options for a particular resource type (pool or origin). Use null to reset.

- `origin_steering: Optional[OriginSteeringParam]`

  Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.

  - `policy: Optional[Literal["random", "hash", "least_outstanding_requests", "least_connections"]]`

    The type of origin steering policy to use.

    - `"random"`: Select an origin randomly.
    - `"hash"`: Select an origin by computing a hash over the CF-Connecting-IP address.
    - `"least_outstanding_requests"`: Select an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others.
    - `"least_connections"`: Select an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.

    - `"random"`

    - `"hash"`

    - `"least_outstanding_requests"`

    - `"least_connections"`

### Returns

- `class Pool: …`

  - `id: Optional[str]`

  - `check_regions: Optional[List[CheckRegion]]`

    A list of regions from which to run health checks. Null means every Cloudflare data center.

    - `"WNAM"`

    - `"ENAM"`

    - `"WEU"`

    - `"EEU"`

    - `"NSAM"`

    - `"SSAM"`

    - `"OC"`

    - `"ME"`

    - `"NAF"`

    - `"SAF"`

    - `"SAS"`

    - `"SEAS"`

    - `"NEAS"`

    - `"ALL_REGIONS"`

  - `created_on: Optional[str]`

  - `description: Optional[str]`

    A human-readable description of the pool.

  - `disabled_at: Optional[datetime]`

    This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.

  - `enabled: Optional[bool]`

    Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).

  - `latitude: Optional[float]`

    The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.

  - `load_shedding: Optional[LoadShedding]`

    Configures load shedding policies and percentages for the pool.

    - `default_percent: Optional[float]`

      The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.

    - `default_policy: Optional[Literal["random", "hash"]]`

      The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs.

      - `"random"`

      - `"hash"`

    - `session_percent: Optional[float]`

      The percent of existing sessions to shed from the pool, according to the session policy.

    - `session_policy: Optional[Literal["hash"]]`

      Only the hash policy is supported for existing sessions (to avoid exponential decay).

      - `"hash"`

  - `longitude: Optional[float]`

    The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.

  - `minimum_origins: Optional[int]`

    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.

  - `modified_on: Optional[str]`

  - `monitor: Optional[str]`

    The ID of the Monitor to use for checking the health of origins within this pool.

  - `monitor_group: Optional[str]`

    The ID of the Monitor Group to use for checking the health of origins within this pool.

  - `name: Optional[str]`

    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.

  - `networks: Optional[List[str]]`

    List of networks where Load Balancer or Pool is enabled.

  - `notification_email: Optional[str]`

    This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.

  - `notification_filter: Optional[NotificationFilter]`

    Filter pool and origin health notifications by resource type or health status. Use null to reset.

    - `origin: Optional[FilterOptions]`

      Filter options for a particular resource type (pool or origin). Use null to reset.

      - `disable: Optional[bool]`

        If set true, disable notifications for this type of resource (pool or origin).

      - `healthy: Optional[bool]`

        If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).

    - `pool: Optional[FilterOptions]`

      Filter options for a particular resource type (pool or origin). Use null to reset.

  - `origin_steering: Optional[OriginSteering]`

    Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.

    - `policy: Optional[Literal["random", "hash", "least_outstanding_requests", "least_connections"]]`

      The type of origin steering policy to use.

      - `"random"`: Select an origin randomly.
      - `"hash"`: Select an origin by computing a hash over the CF-Connecting-IP address.
      - `"least_outstanding_requests"`: Select an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others.
      - `"least_connections"`: Select an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.

      - `"random"`

      - `"hash"`

      - `"least_outstanding_requests"`

      - `"least_connections"`

  - `origins: Optional[List[Origin]]`

    The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

    - `address: Optional[str]`

      The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set.

    - `disabled_at: Optional[datetime]`

      This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.

    - `enabled: Optional[bool]`

      Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.

    - `header: Optional[Header]`

      The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.

      - `host: Optional[List[Host]]`

        The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.

    - `name: Optional[str]`

      A human-identifiable name for the origin.

    - `port: Optional[int]`

      The port for upstream connections. A value of 0 means the default port for the protocol will be used.

    - `virtual_network_id: Optional[str]`

      The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.

    - `weight: Optional[float]`

      The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.

      - `origin_steering.policy="least_outstanding_requests"`: Use weight to scale the origin's outstanding requests.
      - `origin_steering.policy="least_connections"`: Use weight to scale the origin's open connections.

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
pool = client.load_balancers.pools.update(
    pool_id="17b5962d775c646f3f9725cbc7a53df4",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    name="primary-dc-1",
    origins=[{}],
)
print(pool.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "17b5962d775c646f3f9725cbc7a53df4",
    "check_regions": [
      "WEU",
      "ENAM"
    ],
    "created_on": "2014-01-01T05:20:00.12345Z",
    "description": "Primary data center - Provider XYZ",
    "disabled_at": "2019-12-27T18:11:19.117Z",
    "enabled": false,
    "latitude": 0,
    "load_shedding": {
      "default_percent": 0,
      "default_policy": "random",
      "session_percent": 0,
      "session_policy": "hash"
    },
    "longitude": 0,
    "minimum_origins": 0,
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "monitor": "monitor",
    "monitor_group": "monitor_group",
    "name": "primary-dc-1",
    "networks": [
      "string"
    ],
    "notification_email": "someone@example.com,sometwo@example.com",
    "notification_filter": {
      "origin": {
        "disable": true,
        "healthy": true
      },
      "pool": {
        "disable": true,
        "healthy": false
      }
    },
    "origin_steering": {
      "policy": "random"
    },
    "origins": [
      {
        "address": "0.0.0.0",
        "disabled_at": "2019-12-27T18:11:19.117Z",
        "enabled": true,
        "header": {
          "Host": [
            "example.com"
          ]
        },
        "name": "app-server-1",
        "port": 0,
        "virtual_network_id": "a5624d4e-044a-4ff0-b3e1-e2465353d4b4",
        "weight": 0.6
      }
    ]
  },
  "success": true
}
```

## Patch Pool

`load_balancers.pools.edit(strpool_id, PoolEditParams**kwargs)  -> Pool`

**patch** `/accounts/{account_id}/load_balancers/pools/{pool_id}`

Apply changes to an existing pool, overwriting the supplied properties.

### Parameters

- `account_id: str`

  Identifier.

- `pool_id: str`

- `check_regions: Optional[List[CheckRegion]]`

  A list of regions from which to run health checks. Null means every Cloudflare data center.

  - `"WNAM"`

  - `"ENAM"`

  - `"WEU"`

  - `"EEU"`

  - `"NSAM"`

  - `"SSAM"`

  - `"OC"`

  - `"ME"`

  - `"NAF"`

  - `"SAF"`

  - `"SAS"`

  - `"SEAS"`

  - `"NEAS"`

  - `"ALL_REGIONS"`

- `description: Optional[str]`

  A human-readable description of the pool.

- `enabled: Optional[bool]`

  Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).

- `latitude: Optional[float]`

  The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.

- `load_shedding: Optional[LoadSheddingParam]`

  Configures load shedding policies and percentages for the pool.

  - `default_percent: Optional[float]`

    The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.

  - `default_policy: Optional[Literal["random", "hash"]]`

    The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs.

    - `"random"`

    - `"hash"`

  - `session_percent: Optional[float]`

    The percent of existing sessions to shed from the pool, according to the session policy.

  - `session_policy: Optional[Literal["hash"]]`

    Only the hash policy is supported for existing sessions (to avoid exponential decay).

    - `"hash"`

- `longitude: Optional[float]`

  The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.

- `minimum_origins: Optional[int]`

  The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.

- `monitor: Optional[str]`

  The ID of the Monitor to use for checking the health of origins within this pool.

- `monitor_group: Optional[str]`

  The ID of the Monitor Group to use for checking the health of origins within this pool.

- `name: Optional[str]`

  A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.

- `notification_email: Optional[str]`

  This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.

- `notification_filter: Optional[NotificationFilterParam]`

  Filter pool and origin health notifications by resource type or health status. Use null to reset.

  - `origin: Optional[FilterOptions]`

    Filter options for a particular resource type (pool or origin). Use null to reset.

    - `disable: Optional[bool]`

      If set true, disable notifications for this type of resource (pool or origin).

    - `healthy: Optional[bool]`

      If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).

  - `pool: Optional[FilterOptions]`

    Filter options for a particular resource type (pool or origin). Use null to reset.

- `origin_steering: Optional[OriginSteeringParam]`

  Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.

  - `policy: Optional[Literal["random", "hash", "least_outstanding_requests", "least_connections"]]`

    The type of origin steering policy to use.

    - `"random"`: Select an origin randomly.
    - `"hash"`: Select an origin by computing a hash over the CF-Connecting-IP address.
    - `"least_outstanding_requests"`: Select an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others.
    - `"least_connections"`: Select an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.

    - `"random"`

    - `"hash"`

    - `"least_outstanding_requests"`

    - `"least_connections"`

- `origins: Optional[Iterable[OriginParam]]`

  The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

  - `address: Optional[str]`

    The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set.

  - `disabled_at: Optional[datetime]`

    This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.

  - `enabled: Optional[bool]`

    Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.

  - `header: Optional[Header]`

    The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.

    - `host: Optional[List[Host]]`

      The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.

  - `name: Optional[str]`

    A human-identifiable name for the origin.

  - `port: Optional[int]`

    The port for upstream connections. A value of 0 means the default port for the protocol will be used.

  - `virtual_network_id: Optional[str]`

    The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.

  - `weight: Optional[float]`

    The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.

    - `origin_steering.policy="least_outstanding_requests"`: Use weight to scale the origin's outstanding requests.
    - `origin_steering.policy="least_connections"`: Use weight to scale the origin's open connections.

### Returns

- `class Pool: …`

  - `id: Optional[str]`

  - `check_regions: Optional[List[CheckRegion]]`

    A list of regions from which to run health checks. Null means every Cloudflare data center.

    - `"WNAM"`

    - `"ENAM"`

    - `"WEU"`

    - `"EEU"`

    - `"NSAM"`

    - `"SSAM"`

    - `"OC"`

    - `"ME"`

    - `"NAF"`

    - `"SAF"`

    - `"SAS"`

    - `"SEAS"`

    - `"NEAS"`

    - `"ALL_REGIONS"`

  - `created_on: Optional[str]`

  - `description: Optional[str]`

    A human-readable description of the pool.

  - `disabled_at: Optional[datetime]`

    This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.

  - `enabled: Optional[bool]`

    Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).

  - `latitude: Optional[float]`

    The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.

  - `load_shedding: Optional[LoadShedding]`

    Configures load shedding policies and percentages for the pool.

    - `default_percent: Optional[float]`

      The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.

    - `default_policy: Optional[Literal["random", "hash"]]`

      The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs.

      - `"random"`

      - `"hash"`

    - `session_percent: Optional[float]`

      The percent of existing sessions to shed from the pool, according to the session policy.

    - `session_policy: Optional[Literal["hash"]]`

      Only the hash policy is supported for existing sessions (to avoid exponential decay).

      - `"hash"`

  - `longitude: Optional[float]`

    The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.

  - `minimum_origins: Optional[int]`

    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.

  - `modified_on: Optional[str]`

  - `monitor: Optional[str]`

    The ID of the Monitor to use for checking the health of origins within this pool.

  - `monitor_group: Optional[str]`

    The ID of the Monitor Group to use for checking the health of origins within this pool.

  - `name: Optional[str]`

    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.

  - `networks: Optional[List[str]]`

    List of networks where Load Balancer or Pool is enabled.

  - `notification_email: Optional[str]`

    This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.

  - `notification_filter: Optional[NotificationFilter]`

    Filter pool and origin health notifications by resource type or health status. Use null to reset.

    - `origin: Optional[FilterOptions]`

      Filter options for a particular resource type (pool or origin). Use null to reset.

      - `disable: Optional[bool]`

        If set true, disable notifications for this type of resource (pool or origin).

      - `healthy: Optional[bool]`

        If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).

    - `pool: Optional[FilterOptions]`

      Filter options for a particular resource type (pool or origin). Use null to reset.

  - `origin_steering: Optional[OriginSteering]`

    Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.

    - `policy: Optional[Literal["random", "hash", "least_outstanding_requests", "least_connections"]]`

      The type of origin steering policy to use.

      - `"random"`: Select an origin randomly.
      - `"hash"`: Select an origin by computing a hash over the CF-Connecting-IP address.
      - `"least_outstanding_requests"`: Select an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others.
      - `"least_connections"`: Select an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.

      - `"random"`

      - `"hash"`

      - `"least_outstanding_requests"`

      - `"least_connections"`

  - `origins: Optional[List[Origin]]`

    The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

    - `address: Optional[str]`

      The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set.

    - `disabled_at: Optional[datetime]`

      This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.

    - `enabled: Optional[bool]`

      Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.

    - `header: Optional[Header]`

      The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.

      - `host: Optional[List[Host]]`

        The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.

    - `name: Optional[str]`

      A human-identifiable name for the origin.

    - `port: Optional[int]`

      The port for upstream connections. A value of 0 means the default port for the protocol will be used.

    - `virtual_network_id: Optional[str]`

      The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.

    - `weight: Optional[float]`

      The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.

      - `origin_steering.policy="least_outstanding_requests"`: Use weight to scale the origin's outstanding requests.
      - `origin_steering.policy="least_connections"`: Use weight to scale the origin's open connections.

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
pool = client.load_balancers.pools.edit(
    pool_id="17b5962d775c646f3f9725cbc7a53df4",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(pool.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "17b5962d775c646f3f9725cbc7a53df4",
    "check_regions": [
      "WEU",
      "ENAM"
    ],
    "created_on": "2014-01-01T05:20:00.12345Z",
    "description": "Primary data center - Provider XYZ",
    "disabled_at": "2019-12-27T18:11:19.117Z",
    "enabled": false,
    "latitude": 0,
    "load_shedding": {
      "default_percent": 0,
      "default_policy": "random",
      "session_percent": 0,
      "session_policy": "hash"
    },
    "longitude": 0,
    "minimum_origins": 0,
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "monitor": "monitor",
    "monitor_group": "monitor_group",
    "name": "primary-dc-1",
    "networks": [
      "string"
    ],
    "notification_email": "someone@example.com,sometwo@example.com",
    "notification_filter": {
      "origin": {
        "disable": true,
        "healthy": true
      },
      "pool": {
        "disable": true,
        "healthy": false
      }
    },
    "origin_steering": {
      "policy": "random"
    },
    "origins": [
      {
        "address": "0.0.0.0",
        "disabled_at": "2019-12-27T18:11:19.117Z",
        "enabled": true,
        "header": {
          "Host": [
            "example.com"
          ]
        },
        "name": "app-server-1",
        "port": 0,
        "virtual_network_id": "a5624d4e-044a-4ff0-b3e1-e2465353d4b4",
        "weight": 0.6
      }
    ]
  },
  "success": true
}
```

## Delete Pool

`load_balancers.pools.delete(strpool_id, PoolDeleteParams**kwargs)  -> PoolDeleteResponse`

**delete** `/accounts/{account_id}/load_balancers/pools/{pool_id}`

Delete a configured pool.

### Parameters

- `account_id: str`

  Identifier.

- `pool_id: str`

### Returns

- `class PoolDeleteResponse: …`

  - `id: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
pool = client.load_balancers.pools.delete(
    pool_id="17b5962d775c646f3f9725cbc7a53df4",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(pool.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "17b5962d775c646f3f9725cbc7a53df4"
  },
  "success": true
}
```

## Patch Pools

`load_balancers.pools.bulk_edit(PoolBulkEditParams**kwargs)  -> SyncSinglePage[Pool]`

**patch** `/accounts/{account_id}/load_balancers/pools`

Apply changes to a number of existing pools, overwriting the supplied properties. Pools are ordered by ascending `name`. Returns the list of affected pools. Supports the standard pagination query parameters, either `limit`/`offset` or `per_page`/`page`.

### Parameters

- `account_id: str`

  Identifier.

- `notification_email: Optional[Literal[""]]`

  The email address to send health status notifications to. This field is now deprecated in favor of Cloudflare Notifications for Load Balancing, so only resetting this field with an empty string `""` is accepted.

  - `""`

### Returns

- `class Pool: …`

  - `id: Optional[str]`

  - `check_regions: Optional[List[CheckRegion]]`

    A list of regions from which to run health checks. Null means every Cloudflare data center.

    - `"WNAM"`

    - `"ENAM"`

    - `"WEU"`

    - `"EEU"`

    - `"NSAM"`

    - `"SSAM"`

    - `"OC"`

    - `"ME"`

    - `"NAF"`

    - `"SAF"`

    - `"SAS"`

    - `"SEAS"`

    - `"NEAS"`

    - `"ALL_REGIONS"`

  - `created_on: Optional[str]`

  - `description: Optional[str]`

    A human-readable description of the pool.

  - `disabled_at: Optional[datetime]`

    This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.

  - `enabled: Optional[bool]`

    Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).

  - `latitude: Optional[float]`

    The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.

  - `load_shedding: Optional[LoadShedding]`

    Configures load shedding policies and percentages for the pool.

    - `default_percent: Optional[float]`

      The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.

    - `default_policy: Optional[Literal["random", "hash"]]`

      The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs.

      - `"random"`

      - `"hash"`

    - `session_percent: Optional[float]`

      The percent of existing sessions to shed from the pool, according to the session policy.

    - `session_policy: Optional[Literal["hash"]]`

      Only the hash policy is supported for existing sessions (to avoid exponential decay).

      - `"hash"`

  - `longitude: Optional[float]`

    The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.

  - `minimum_origins: Optional[int]`

    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.

  - `modified_on: Optional[str]`

  - `monitor: Optional[str]`

    The ID of the Monitor to use for checking the health of origins within this pool.

  - `monitor_group: Optional[str]`

    The ID of the Monitor Group to use for checking the health of origins within this pool.

  - `name: Optional[str]`

    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.

  - `networks: Optional[List[str]]`

    List of networks where Load Balancer or Pool is enabled.

  - `notification_email: Optional[str]`

    This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.

  - `notification_filter: Optional[NotificationFilter]`

    Filter pool and origin health notifications by resource type or health status. Use null to reset.

    - `origin: Optional[FilterOptions]`

      Filter options for a particular resource type (pool or origin). Use null to reset.

      - `disable: Optional[bool]`

        If set true, disable notifications for this type of resource (pool or origin).

      - `healthy: Optional[bool]`

        If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).

    - `pool: Optional[FilterOptions]`

      Filter options for a particular resource type (pool or origin). Use null to reset.

  - `origin_steering: Optional[OriginSteering]`

    Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.

    - `policy: Optional[Literal["random", "hash", "least_outstanding_requests", "least_connections"]]`

      The type of origin steering policy to use.

      - `"random"`: Select an origin randomly.
      - `"hash"`: Select an origin by computing a hash over the CF-Connecting-IP address.
      - `"least_outstanding_requests"`: Select an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others.
      - `"least_connections"`: Select an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.

      - `"random"`

      - `"hash"`

      - `"least_outstanding_requests"`

      - `"least_connections"`

  - `origins: Optional[List[Origin]]`

    The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

    - `address: Optional[str]`

      The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set.

    - `disabled_at: Optional[datetime]`

      This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.

    - `enabled: Optional[bool]`

      Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.

    - `header: Optional[Header]`

      The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.

      - `host: Optional[List[Host]]`

        The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.

    - `name: Optional[str]`

      A human-identifiable name for the origin.

    - `port: Optional[int]`

      The port for upstream connections. A value of 0 means the default port for the protocol will be used.

    - `virtual_network_id: Optional[str]`

      The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.

    - `weight: Optional[float]`

      The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.

      - `origin_steering.policy="least_outstanding_requests"`: Use weight to scale the origin's outstanding requests.
      - `origin_steering.policy="least_connections"`: Use weight to scale the origin's open connections.

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
page = client.load_balancers.pools.bulk_edit(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
page = page.result[0]
print(page.id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "17b5962d775c646f3f9725cbc7a53df4",
      "check_regions": [
        "WEU",
        "ENAM"
      ],
      "created_on": "2014-01-01T05:20:00.12345Z",
      "description": "Primary data center - Provider XYZ",
      "disabled_at": "2019-12-27T18:11:19.117Z",
      "enabled": false,
      "latitude": 0,
      "load_shedding": {
        "default_percent": 0,
        "default_policy": "random",
        "session_percent": 0,
        "session_policy": "hash"
      },
      "longitude": 0,
      "minimum_origins": 0,
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "monitor": "monitor",
      "monitor_group": "monitor_group",
      "name": "primary-dc-1",
      "networks": [
        "string"
      ],
      "notification_email": "someone@example.com,sometwo@example.com",
      "notification_filter": {
        "origin": {
          "disable": true,
          "healthy": true
        },
        "pool": {
          "disable": true,
          "healthy": false
        }
      },
      "origin_steering": {
        "policy": "random"
      },
      "origins": [
        {
          "address": "0.0.0.0",
          "disabled_at": "2019-12-27T18:11:19.117Z",
          "enabled": true,
          "header": {
            "Host": [
              "example.com"
            ]
          },
          "name": "app-server-1",
          "port": 0,
          "virtual_network_id": "a5624d4e-044a-4ff0-b3e1-e2465353d4b4",
          "weight": 0.6
        }
      ]
    }
  ],
  "success": true,
  "result_info": {
    "count": 20,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}
```

## Domain Types

### Pool

- `class Pool: …`

  - `id: Optional[str]`

  - `check_regions: Optional[List[CheckRegion]]`

    A list of regions from which to run health checks. Null means every Cloudflare data center.

    - `"WNAM"`

    - `"ENAM"`

    - `"WEU"`

    - `"EEU"`

    - `"NSAM"`

    - `"SSAM"`

    - `"OC"`

    - `"ME"`

    - `"NAF"`

    - `"SAF"`

    - `"SAS"`

    - `"SEAS"`

    - `"NEAS"`

    - `"ALL_REGIONS"`

  - `created_on: Optional[str]`

  - `description: Optional[str]`

    A human-readable description of the pool.

  - `disabled_at: Optional[datetime]`

    This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.

  - `enabled: Optional[bool]`

    Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).

  - `latitude: Optional[float]`

    The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.

  - `load_shedding: Optional[LoadShedding]`

    Configures load shedding policies and percentages for the pool.

    - `default_percent: Optional[float]`

      The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.

    - `default_policy: Optional[Literal["random", "hash"]]`

      The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs.

      - `"random"`

      - `"hash"`

    - `session_percent: Optional[float]`

      The percent of existing sessions to shed from the pool, according to the session policy.

    - `session_policy: Optional[Literal["hash"]]`

      Only the hash policy is supported for existing sessions (to avoid exponential decay).

      - `"hash"`

  - `longitude: Optional[float]`

    The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.

  - `minimum_origins: Optional[int]`

    The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.

  - `modified_on: Optional[str]`

  - `monitor: Optional[str]`

    The ID of the Monitor to use for checking the health of origins within this pool.

  - `monitor_group: Optional[str]`

    The ID of the Monitor Group to use for checking the health of origins within this pool.

  - `name: Optional[str]`

    A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.

  - `networks: Optional[List[str]]`

    List of networks where Load Balancer or Pool is enabled.

  - `notification_email: Optional[str]`

    This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.

  - `notification_filter: Optional[NotificationFilter]`

    Filter pool and origin health notifications by resource type or health status. Use null to reset.

    - `origin: Optional[FilterOptions]`

      Filter options for a particular resource type (pool or origin). Use null to reset.

      - `disable: Optional[bool]`

        If set true, disable notifications for this type of resource (pool or origin).

      - `healthy: Optional[bool]`

        If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).

    - `pool: Optional[FilterOptions]`

      Filter options for a particular resource type (pool or origin). Use null to reset.

  - `origin_steering: Optional[OriginSteering]`

    Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.

    - `policy: Optional[Literal["random", "hash", "least_outstanding_requests", "least_connections"]]`

      The type of origin steering policy to use.

      - `"random"`: Select an origin randomly.
      - `"hash"`: Select an origin by computing a hash over the CF-Connecting-IP address.
      - `"least_outstanding_requests"`: Select an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others.
      - `"least_connections"`: Select an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.

      - `"random"`

      - `"hash"`

      - `"least_outstanding_requests"`

      - `"least_connections"`

  - `origins: Optional[List[Origin]]`

    The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

    - `address: Optional[str]`

      The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set.

    - `disabled_at: Optional[datetime]`

      This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.

    - `enabled: Optional[bool]`

      Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.

    - `header: Optional[Header]`

      The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.

      - `host: Optional[List[Host]]`

        The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.

    - `name: Optional[str]`

      A human-identifiable name for the origin.

    - `port: Optional[int]`

      The port for upstream connections. A value of 0 means the default port for the protocol will be used.

    - `virtual_network_id: Optional[str]`

      The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.

    - `weight: Optional[float]`

      The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.

      - `origin_steering.policy="least_outstanding_requests"`: Use weight to scale the origin's outstanding requests.
      - `origin_steering.policy="least_connections"`: Use weight to scale the origin's open connections.

### Pool Delete Response

- `class PoolDeleteResponse: …`

  - `id: Optional[str]`

# Health

## Pool Health Details

`load_balancers.pools.health.get(strpool_id, HealthGetParams**kwargs)  -> HealthGetResponse`

**get** `/accounts/{account_id}/load_balancers/pools/{pool_id}/health`

Fetch the latest pool health status for a single pool.

### Parameters

- `account_id: str`

  Identifier.

- `pool_id: str`

### Returns

- `class HealthGetResponse: …`

  A list of regions from which to run health checks. Null means every Cloudflare data center.

  - `pool_id: Optional[str]`

    Pool ID.

  - `pop_health: Optional[POPHealth]`

    List of regions and associated health status.

    - `healthy: Optional[bool]`

      Whether health check in region is healthy.

    - `origins: Optional[List[POPHealthOrigin]]`

      - `ip: Optional[POPHealthOriginIP]`

        - `failure_reason: Optional[str]`

          Failure reason.

        - `healthy: Optional[bool]`

          Origin health status.

        - `response_code: Optional[float]`

          Response code from origin health check.

        - `rtt: Optional[str]`

          Origin RTT (Round Trip Time) response.

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
health = client.load_balancers.pools.health.get(
    pool_id="17b5962d775c646f3f9725cbc7a53df4",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(health.pool_id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "pool_id": "17b5962d775c646f3f9725cbc7a53df4",
    "pop_health": {
      "healthy": true,
      "origins": [
        {
          "ip": {
            "failure_reason": "No failure reasons",
            "healthy": true,
            "response_code": 200,
            "rtt": "201.5ms"
          }
        }
      ]
    }
  },
  "success": true
}
```

## Preview Pool

`load_balancers.pools.health.create(strpool_id, HealthCreateParams**kwargs)  -> HealthCreateResponse`

**post** `/accounts/{account_id}/load_balancers/pools/{pool_id}/preview`

Preview pool health using provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.

### Parameters

- `account_id: str`

  Identifier.

- `pool_id: str`

- `allow_insecure: Optional[bool]`

  Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.

- `consecutive_down: Optional[int]`

  To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.

- `consecutive_up: Optional[int]`

  To be marked healthy the monitored origin must pass this healthcheck N consecutive times.

- `description: Optional[str]`

  Object description.

- `expected_body: Optional[str]`

  A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.

- `expected_codes: Optional[str]`

  The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.

- `follow_redirects: Optional[bool]`

  Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.

- `header: Optional[Dict[str, SequenceNotStr[str]]]`

  The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.

- `interval: Optional[int]`

  The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.

- `method: Optional[str]`

  The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.

- `path: Optional[str]`

  The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.

- `port: Optional[int]`

  The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).

- `probe_zone: Optional[str]`

  Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.

- `retries: Optional[int]`

  The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.

- `load_balancer_monitor_timeout: Optional[int]`

  The timeout (in seconds) before marking the health check as failed.

- `type: Optional[Literal["http", "https", "tcp", 3 more]]`

  The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'.

  - `"http"`

  - `"https"`

  - `"tcp"`

  - `"udp_icmp"`

  - `"icmp_ping"`

  - `"smtp"`

### Returns

- `class HealthCreateResponse: …`

  - `pools: Optional[Dict[str, str]]`

    Monitored pool IDs mapped to their respective names.

  - `preview_id: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
health = client.load_balancers.pools.health.create(
    pool_id="17b5962d775c646f3f9725cbc7a53df4",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(health.preview_id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "pools": {
      "abwlnp5jbqn45ecgxd03erbgtxtqai0d": "WNAM Datacenter",
      "ve8h9lrcip5n5bbga9yqmdws28ay5d0l": "EEU Datacenter"
    },
    "preview_id": "f1aba936b94213e5b8dca0c0dbf1f9cc"
  },
  "success": true
}
```

## Domain Types

### Health Get Response

- `class HealthGetResponse: …`

  A list of regions from which to run health checks. Null means every Cloudflare data center.

  - `pool_id: Optional[str]`

    Pool ID.

  - `pop_health: Optional[POPHealth]`

    List of regions and associated health status.

    - `healthy: Optional[bool]`

      Whether health check in region is healthy.

    - `origins: Optional[List[POPHealthOrigin]]`

      - `ip: Optional[POPHealthOriginIP]`

        - `failure_reason: Optional[str]`

          Failure reason.

        - `healthy: Optional[bool]`

          Origin health status.

        - `response_code: Optional[float]`

          Response code from origin health check.

        - `rtt: Optional[str]`

          Origin RTT (Round Trip Time) response.

### Health Create Response

- `class HealthCreateResponse: …`

  - `pools: Optional[Dict[str, str]]`

    Monitored pool IDs mapped to their respective names.

  - `preview_id: Optional[str]`

# References

## List Pool References

`load_balancers.pools.references.get(strpool_id, ReferenceGetParams**kwargs)  -> SyncSinglePage[ReferenceGetResponse]`

**get** `/accounts/{account_id}/load_balancers/pools/{pool_id}/references`

Get the list of resources that reference the provided pool.

### Parameters

- `account_id: str`

  Identifier.

- `pool_id: str`

### Returns

- `class ReferenceGetResponse: …`

  - `reference_type: Optional[Literal["*", "referral", "referrer"]]`

    - `"*"`

    - `"referral"`

    - `"referrer"`

  - `resource_id: Optional[str]`

  - `resource_name: Optional[str]`

  - `resource_type: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
page = client.load_balancers.pools.references.get(
    pool_id="17b5962d775c646f3f9725cbc7a53df4",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
page = page.result[0]
print(page.resource_id)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "reference_type": "referrer",
      "resource_id": "699d98642c564d2e855e9661899b7252",
      "resource_name": "www.example.com",
      "resource_type": "load_balancer"
    },
    {
      "reference_type": "referral",
      "resource_id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
      "resource_name": "Login page monitor",
      "resource_type": "monitor"
    }
  ],
  "success": true
}
```

## Domain Types

### Reference Get Response

- `class ReferenceGetResponse: …`

  - `reference_type: Optional[Literal["*", "referral", "referrer"]]`

    - `"*"`

    - `"referral"`

    - `"referrer"`

  - `resource_id: Optional[str]`

  - `resource_name: Optional[str]`

  - `resource_type: Optional[str]`

# Previews

## Preview Result

`load_balancers.previews.get(strpreview_id, PreviewGetParams**kwargs)  -> PreviewGetResponse`

**get** `/accounts/{account_id}/load_balancers/preview/{preview_id}`

Get the result of a previous preview operation using the provided preview_id.

### Parameters

- `account_id: str`

  Identifier.

- `preview_id: str`

### Returns

- `Dict[str, PreviewGetResponseItem]`

  Resulting health data from a preview operation.

  - `healthy: Optional[bool]`

  - `origins: Optional[List[Dict[str, PreviewGetResponseItemOriginPreviewGetResponseItemOriginItem]]]`

    - `failure_reason: Optional[str]`

    - `healthy: Optional[bool]`

    - `response_code: Optional[float]`

    - `rtt: Optional[str]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
preview = client.load_balancers.previews.get(
    preview_id="p1aba936b94213e5b8dca0c0dbf1f9cc",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(preview)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "abwlnp5jbqn45ecgxd03erbgtxtqai0d": {
      "healthy": true,
      "origins": [
        {
          "originone.example.com.": {
            "failure_reason": "No failures",
            "healthy": true,
            "response_code": 200,
            "rtt": "66ms"
          }
        }
      ]
    }
  },
  "success": true
}
```

## Domain Types

### Preview Get Response

- `Dict[str, PreviewGetResponseItem]`

  Resulting health data from a preview operation.

  - `healthy: Optional[bool]`

  - `origins: Optional[List[Dict[str, PreviewGetResponseItemOriginPreviewGetResponseItemOriginItem]]]`

    - `failure_reason: Optional[str]`

    - `healthy: Optional[bool]`

    - `response_code: Optional[float]`

    - `rtt: Optional[str]`

# Regions

## List Regions

`load_balancers.regions.list(RegionListParams**kwargs)  -> RegionListResponse`

**get** `/accounts/{account_id}/load_balancers/regions`

List all region mappings.

### Parameters

- `account_id: str`

  Identifier.

- `country_code_a2: Optional[str]`

  Two-letter alpha-2 country code followed in ISO 3166-1.

- `subdivision_code: Optional[str]`

  Two-letter subdivision code followed in ISO 3166-2.

- `subdivision_code_a2: Optional[str]`

  Two-letter subdivision code followed in ISO 3166-2.

### Returns

- `Union[Optional[str], Optional[object]]`

  - `Optional[str]`

  - `Optional[object]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
regions = client.load_balancers.regions.list(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(regions)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {},
  "success": true
}
```

## Get Region

`load_balancers.regions.get(Literal["WNAM", "ENAM", "WEU", 10 more]region_id, RegionGetParams**kwargs)  -> RegionGetResponse`

**get** `/accounts/{account_id}/load_balancers/regions/{region_id}`

Get a single region mapping.

### Parameters

- `account_id: str`

  Identifier.

- `region_id: Literal["WNAM", "ENAM", "WEU", 10 more]`

  A list of Cloudflare regions. WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, SAS: Southern Asia, SEAS: South East Asia, NEAS: North East Asia).

  - `"WNAM"`

  - `"ENAM"`

  - `"WEU"`

  - `"EEU"`

  - `"NSAM"`

  - `"SSAM"`

  - `"OC"`

  - `"ME"`

  - `"NAF"`

  - `"SAF"`

  - `"SAS"`

  - `"SEAS"`

  - `"NEAS"`

### Returns

- `Union[Optional[str], Optional[object]]`

  A list of countries and subdivisions mapped to a region.

  - `Optional[str]`

  - `Optional[object]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
region = client.load_balancers.regions.get(
    region_id="WNAM",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(region)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "iso_standard": "Country and subdivision codes follow ISO 3166-1 alpha-2 and ISO 3166-2",
    "regions": [
      {
        "countries": [
          {
            "country_code_a2": "CA",
            "country_name": "Canada",
            "country_subdivisions": [
              {
                "subdivision_code_a2": "AB",
                "subdivision_name": "Alberta"
              },
              {
                "subdivision_code_a2": "BC",
                "subdivision_name": "British Columbia"
              }
            ]
          },
          {
            "country_code_a2": "HT",
            "country_name": "Haiti"
          },
          {
            "country_code_a2": "MX",
            "country_name": "Mexico"
          },
          {
            "country_code_a2": "US",
            "country_name": "United States",
            "country_subdivisions": [
              {
                "subdivision_code_a2": "AZ",
                "subdivision_name": "Arizona"
              },
              {
                "subdivision_code_a2": "CA",
                "subdivision_name": "California"
              },
              {
                "subdivision_code_a2": "CO",
                "subdivision_name": "Colorado"
              },
              {
                "subdivision_code_a2": "HI",
                "subdivision_name": "Hawaii"
              },
              {
                "subdivision_code_a2": "MN",
                "subdivision_name": "Minnesota"
              },
              {
                "subdivision_code_a2": "MO",
                "subdivision_name": "Missouri"
              },
              {
                "subdivision_code_a2": "NV",
                "subdivision_name": "Nevada"
              },
              {
                "subdivision_code_a2": "OR",
                "subdivision_name": "Oregon"
              },
              {
                "subdivision_code_a2": "TX",
                "subdivision_name": "Texas"
              },
              {
                "subdivision_code_a2": "UT",
                "subdivision_name": "Utah"
              },
              {
                "subdivision_code_a2": "WA",
                "subdivision_name": "Washington"
              }
            ]
          }
        ],
        "region_code": "WNAM"
      }
    ]
  },
  "success": true
}
```

## Domain Types

### Region List Response

- `Union[Optional[str], Optional[object]]`

  - `Optional[str]`

  - `Optional[object]`

### Region Get Response

- `Union[Optional[str], Optional[object]]`

  A list of countries and subdivisions mapped to a region.

  - `Optional[str]`

  - `Optional[object]`

# Searches

## Search Resources

`load_balancers.searches.list(SearchListParams**kwargs)  -> SyncV4PagePagination[SearchListResponse]`

**get** `/accounts/{account_id}/load_balancers/search`

Search for Load Balancing resources.

### Parameters

- `account_id: str`

  Identifier.

- `page: Optional[float]`

- `per_page: Optional[float]`

- `query: Optional[str]`

  Search query term.

- `references: Optional[Literal["", "*", "referral", "referrer"]]`

  The type of references to include. "*" to include both referral and referrer references. "" to not include any reference information.

  - `""`

  - `"*"`

  - `"referral"`

  - `"referrer"`

### Returns

- `class SearchListResponse: …`

  - `resources: Optional[List[Resource]]`

    A list of resources matching the search query.

    - `reference_type: Optional[Literal["referral", "referrer"]]`

      When listed as a reference, the type (direction) of the reference.

      - `"referral"`

      - `"referrer"`

    - `references: Optional[List[object]]`

      A list of references to (referrer) or from (referral) this resource.

    - `resource_id: Optional[str]`

    - `resource_name: Optional[str]`

      The human-identifiable name of the resource.

    - `resource_type: Optional[Literal["load_balancer", "monitor", "pool"]]`

      The type of the resource.

      - `"load_balancer"`

      - `"monitor"`

      - `"pool"`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
page = client.load_balancers.searches.list(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
page = page.result.items[0]
print(page.resources)
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "resources": [
      {
        "reference_type": "referral",
        "references": [
          {
            "reference_type": "referrer",
            "resource_id": "699d98642c564d2e855e9661899b7252",
            "resource_name": "www.example.com",
            "resource_type": "load_balancer"
          },
          {
            "reference_type": "referral",
            "resource_id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
            "resource_name": "Login page monitor",
            "resource_type": "monitor"
          }
        ],
        "resource_id": "17b5962d775c646f3f9725cbc7a53df4",
        "resource_name": "primary-dc-1",
        "resource_type": "pool"
      }
    ]
  },
  "success": true,
  "result_info": {
    "count": 20,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}
```

## Domain Types

### Search List Response

- `class SearchListResponse: …`

  - `resources: Optional[List[Resource]]`

    A list of resources matching the search query.

    - `reference_type: Optional[Literal["referral", "referrer"]]`

      When listed as a reference, the type (direction) of the reference.

      - `"referral"`

      - `"referrer"`

    - `references: Optional[List[object]]`

      A list of references to (referrer) or from (referral) this resource.

    - `resource_id: Optional[str]`

    - `resource_name: Optional[str]`

      The human-identifiable name of the resource.

    - `resource_type: Optional[Literal["load_balancer", "monitor", "pool"]]`

      The type of the resource.

      - `"load_balancer"`

      - `"monitor"`

      - `"pool"`