--- title: account or zone Load Balancer Details --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Load Balancers](https://developers.cloudflare.com/api/typescript/resources/load_balancers) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # account or zone Load Balancer Details client.loadBalancers.get(stringloadBalancerID, LoadBalancerGetParams {account\_id, zone\_id } params?, RequestOptionsoptions?): [LoadBalancer]() {id, adaptive\_routing, country\_pools, 21 more } GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/load\_balancers/{load\_balancer\_id} Fetch a single configured account or zone-scoped load balancer. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Load Balancers Account Write``Load Balancers Account Read` ##### ParametersExpand Collapse loadBalancerID: string [Link to this property](<#(resource)%20load_balancers%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20load_balancer_id%20%3E%20(schema)>)
params: LoadBalancerGetParams {account\_id, zone\_id } account\_id?: string The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. Link to this property zone\_id?: string The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. Link to this property
[Link to this property](<#(resource)%20load_balancers%20%3E%20(method)%20get%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
LoadBalancer {id, adaptive\_routing, country\_pools, 21 more } id?: string Link to this property
adaptive\_routing?: AdaptiveRouting {failover\_across\_pools } 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?: boolean 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. Link to this property
Link to this property country\_pools?: Record<string, Array<string>> 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. Link to this property created\_on?: string Link to this property default\_pools?: Array<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. Link to this property description?: string Object description. Link to this property enabled?: boolean Whether to enable (the default) this load balancer. Link to this property fallback\_pool?: string The pool ID to use when all other pools are detected as unhealthy. Link to this property
location\_strategy?: LocationStrategy {mode, prefer\_ecs } Controls location-based steering for non-proxied requests. See steering_policy to learn how steering is affected.
mode?: "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. One of the following: "pop" Link to this property "resolver\_ip" Link to this property
Link to this property
prefer\_ecs?: "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". One of the following: "always" Link to this property "never" Link to this property "proximity" Link to this property "geo" Link to this property
Link to this property
Link to this property modified\_on?: string Link to this property name?: string 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. Link to this property networks?: Array<string> List of networks where Load Balancer or Pool is enabled. Link to this property
pool\_sets?: Array<PoolSet> An optional list of pool sets, evaluated in array order with first match wins. Pool sets are independent from the standard steering fields (region_pools / country_pools / pop_pools / default_pools / steering_policy / random_steering / fallback_pool / rules). On a PATCH, an empty array (pool_sets: []) clears all pool sets, while omitting the field leaves existing pool sets unchanged. disabled?: boolean Disable this specific pool set. It will no longer be evaluated. Link to this property
fixed\_response?: FixedResponse {content\_type, location, message\_body, status\_code } A collection of fields used to directly respond to the client instead of routing to a pool. When supplied on a rule, that rule stops further rule evaluation. content\_type?: string The http ‘Content-Type’ header to include in the response. maxLength32 Link to this property location?: string The http ‘Location’ header to include in the response. maxLength2048 Link to this property message\_body?: string Text to include as the http body. maxLength1024 Link to this property status\_code?: number The http status code to respond with. Link to this property
Link to this property
match?: Match {default, topology } Determines which requests a pool set applies to. Set topology to match by location or default: true to match all requests; the two are mutually exclusive. A pool set with no match matches all requests. default?: boolean When true, matches every request. Cannot be combined with topology. Link to this property
topology?: Topology {countries, pops, regions } Matches requests by location. Set any combination of pops, countries, and regions (at least one is required); a request matches when its value appears in any populated list (e.g. regions: ["WNAM"] with countries: ["US"] matches a request in either WNAM or the US). countries?: Array<string> A list of ISO 3166-1 alpha-2 country codes. Matches when the request’s country is in this list. Link to this property pops?: Array<string> A list of Cloudflare PoP codes. Matches when the request’s PoP is in this list. Link to this property regions?: Array<string> A list of Cloudflare region codes (e.g. WNAM, ENAM, WEU). Matches when the request’s region is in this list. Link to this property
Link to this property
Link to this property name?: string A human-readable name for this pool set. maxLength200 Link to this property
overrides?: Overrides {fallback\_pool, pool\_default\_weight, pool\_weights, 2 more } The behavior a pool set applies when its match succeeds. A strict subset of a rule’s overrides: a pool set replaces the topology wholesale with a flat pool list (pools), so only the declarative pool-routing fields plus fallback_pool and steering_policy are settable. All fields are optional. fallback\_pool?: string The pool ID to use when all other pools are detected as unhealthy. Link to this property pool\_default\_weight?: number The default weight for pools not listed in pool_weights. The declarative alternative to random_steering.default_weight; mutually exclusive with random_steering. maximum1 minimum0 multipleOf0.1 Link to this property pool\_weights?: Record<string, number> A mapping of pool IDs to custom weights, relative to the other pools. The declarative alternative to random_steering.pool_weights; mutually exclusive with random_steering. Link to this property pools?: Array<string> A flat, ordered list of pool IDs to route the matched audience to. Replaces the resolved topology with exactly these pools. Mutually exclusive with fixed_response. Link to this property
steering\_policy?: 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". One of the following: "off" Link to this property "geo" Link to this property "random" Link to this property "dynamic\_latency" Link to this property "proximity" Link to this property "least\_outstanding\_requests" Link to this property "least\_connections" Link to this property "" Link to this property
Link to this property
Link to this property
Link to this property pop\_pools?: Record<string, Array<string>> 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. Link to this property proxied?: boolean Whether the hostname should be gray clouded (false) or orange clouded (true). Link to this property
random\_steering?: RandomSteering {default\_weight, pool\_weights } 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?: number The default weight for pools in the load balancer that are not specified in the pool\_weights map. maximum1 minimum0 multipleOf0.1 Link to this property pool\_weights?: Record<string, number> A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer. Link to this property
Link to this property region\_pools?: Record<string, Array<string>> 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. Link to this property
rules?: Array<Rules {condition, disabled, fixed\_response, 4 more } > BETA Field Not General Access: A list of rules for this load balancer to execute. condition?: string 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. Link to this property disabled?: boolean Disable this specific rule. It will no longer be evaluated by this load balancer. Link to this property
fixed\_response?: FixedResponse {content\_type, location, message\_body, status\_code } A collection of fields used to directly respond to the client instead of routing to a pool. When supplied on a rule, that rule stops further rule evaluation. content\_type?: string The http ‘Content-Type’ header to include in the response. maxLength32 Link to this property location?: string The http ‘Location’ header to include in the response. maxLength2048 Link to this property message\_body?: string Text to include as the http body. maxLength1024 Link to this property status\_code?: number The http status code to respond with. Link to this property
Link to this property name?: string Name of this rule. Only used for human readability. maxLength200 Link to this property
overrides?: Overrides {adaptive\_routing, country\_pools, default\_pools, 13 more } A collection of overrides to apply when this rule’s condition (or a pool set’s match) is true. All fields are optional.
adaptive\_routing?: AdaptiveRouting {failover\_across\_pools } 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?: boolean 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. Link to this property
Link to this property country\_pools?: Record<string, Array<string>> 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. Link to this property default\_pools?: Array<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. Link to this property fallback\_pool?: string The pool ID to use when all other pools are detected as unhealthy. Link to this property
location\_strategy?: LocationStrategy {mode, prefer\_ecs } Controls location-based steering for non-proxied requests. See steering_policy to learn how steering is affected.
mode?: "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. One of the following: "pop" Link to this property "resolver\_ip" Link to this property
Link to this property
prefer\_ecs?: "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". One of the following: "always" Link to this property "never" Link to this property "proximity" Link to this property "geo" Link to this property
Link to this property
Link to this property pool\_default\_weight?: number The default weight for pools not listed in pool_weights. The declarative alternative to random_steering.default_weight; mutually exclusive with random_steering. maximum1 minimum0 multipleOf0.1 Link to this property pool\_weights?: Record<string, number> A mapping of pool IDs to custom weights, relative to the other pools. The declarative alternative to random_steering.pool_weights; mutually exclusive with random_steering. Link to this property pools?: Array<string> A flat, ordered list of pool IDs to route the matched audience to. Replaces the resolved topology with exactly these pools. Mutually exclusive with fixed_response. Link to this property pop\_pools?: Record<string, Array<string>> 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. Link to this property
random\_steering?: RandomSteering {default\_weight, pool\_weights } 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?: number The default weight for pools in the load balancer that are not specified in the pool\_weights map. maximum1 minimum0 multipleOf0.1 Link to this property pool\_weights?: Record<string, number> A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer. Link to this property
Link to this property region\_pools?: Record<string, Array<string>> 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. Link to this property
session\_affinity?: 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. One of the following: "none" Link to this property "cookie" Link to this property "ip\_cookie" Link to this property "header" Link to this property
Link to this property
session\_affinity\_attributes?: SessionAffinityAttributes {drain\_duration, headers, require\_all\_headers, 3 more } Configures attributes for session affinity. drain\_duration?: number Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer. Link to this property headers?: Array<string> 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. Link to this property require\_all\_headers?: boolean 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. Link to this property
samesite?: "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”. One of the following: "Auto" Link to this property "Lax" Link to this property "None" Link to this property "Strict" Link to this property
Link to this property
secure?: "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. One of the following: "Auto" Link to this property "Always" Link to this property "Never" Link to this property
Link to this property
zero\_downtime\_failover?: "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. One of the following: "none" Link to this property "temporary" Link to this property "sticky" Link to this property
Link to this property
Link to this property session\_affinity\_ttl?: number 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. Link to this property
steering\_policy?: 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". One of the following: "off" Link to this property "geo" Link to this property "random" Link to this property "dynamic\_latency" Link to this property "proximity" Link to this property "least\_outstanding\_requests" Link to this property "least\_connections" Link to this property "" Link to this property
Link to this property ttl?: number 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. Link to this property
Link to this property priority?: number 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. minimum0 Link to this property terminates?: boolean If this rule’s condition is true, this causes rule evaluation to stop after processing this rule. Link to this property
Link to this property
session\_affinity?: 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. One of the following: "none" Link to this property "cookie" Link to this property "ip\_cookie" Link to this property "header" Link to this property
Link to this property
session\_affinity\_attributes?: SessionAffinityAttributes {drain\_duration, headers, require\_all\_headers, 3 more } Configures attributes for session affinity. drain\_duration?: number Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer. Link to this property headers?: Array<string> 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. Link to this property require\_all\_headers?: boolean 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. Link to this property
samesite?: "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”. One of the following: "Auto" Link to this property "Lax" Link to this property "None" Link to this property "Strict" Link to this property
Link to this property
secure?: "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. One of the following: "Auto" Link to this property "Always" Link to this property "Never" Link to this property
Link to this property
zero\_downtime\_failover?: "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. One of the following: "none" Link to this property "temporary" Link to this property "sticky" Link to this property
Link to this property
Link to this property session\_affinity\_ttl?: number 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. Link to this property
steering\_policy?: 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". One of the following: "off" Link to this property "geo" Link to this property "random" Link to this property "dynamic\_latency" Link to this property "proximity" Link to this property "least\_outstanding\_requests" Link to this property "least\_connections" Link to this property "" Link to this property
Link to this property ttl?: number 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. Link to this property zone\_name?: string Link to this property
[Link to this property](<#(resource)%20load_balancers%20%3E%20(model)%20load_balancer%20%3E%20(schema)>) ### account or zone Load Balancer Details TypeScript HTTPTypeScriptPythonGoTerraform ``` import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const loadBalancer = await client.loadBalancers.get('699d98642c564d2e855e9661899b7252', { account_id: 'account_id', }); console.log(loadBalancer.id); ``` 200 example ``` { "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" ], "pool_sets": [ { "disabled": true, "fixed_response": { "content_type": "application/json", "location": "www.example.com", "message_body": "Testing Hello", "status_code": 0 }, "match": { "default": true, "topology": { "countries": [ "string" ], "pops": [ "string" ], "regions": [ "WNAM" ] } }, "name": "wnam-primary", "overrides": { "fallback_pool": "9290f38c5d07c2e2f4df57b1f61d4196", "pool_default_weight": 0.2, "pool_weights": { "9290f38c5d07c2e2f4df57b1f61d4196": 0.5, "de90f38ced07c2e2f4df50b1f61d4194": 0.3 }, "pools": [ "17b5962d775c646f3f9725cbc7a53df4" ], "steering_policy": "random" } } ], "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" }, "pool_default_weight": 0.2, "pool_weights": { "9290f38c5d07c2e2f4df57b1f61d4196": 0.5, "de90f38ced07c2e2f4df50b1f61d4194": 0.3 }, "pools": [ "17b5962d775c646f3f9725cbc7a53df4" ], "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 } ``` ##### Returns Examples 200 example ``` { "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" ], "pool_sets": [ { "disabled": true, "fixed_response": { "content_type": "application/json", "location": "www.example.com", "message_body": "Testing Hello", "status_code": 0 }, "match": { "default": true, "topology": { "countries": [ "string" ], "pops": [ "string" ], "regions": [ "WNAM" ] } }, "name": "wnam-primary", "overrides": { "fallback_pool": "9290f38c5d07c2e2f4df57b1f61d4196", "pool_default_weight": 0.2, "pool_weights": { "9290f38c5d07c2e2f4df57b1f61d4196": 0.5, "de90f38ced07c2e2f4df50b1f61d4194": 0.3 }, "pools": [ "17b5962d775c646f3f9725cbc7a53df4" ], "steering_policy": "random" } } ], "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" }, "pool_default_weight": 0.2, "pool_weights": { "9290f38c5d07c2e2f4df57b1f61d4196": 0.5, "de90f38ced07c2e2f4df50b1f61d4194": 0.3 }, "pools": [ "17b5962d775c646f3f9725cbc7a53df4" ], "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 } ```