--- title: Load Balancers --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Load Balancers ##### [List account or zone Load Balancers](https://developers.cloudflare.com/api/go/resources/load_balancers/methods/list) client.LoadBalancers.List(ctx, query) (\*SinglePage\[[LoadBalancer]()], error) GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/load\_balancers ##### [account or zone Load Balancer Details](https://developers.cloudflare.com/api/go/resources/load_balancers/methods/get) client.LoadBalancers.Get(ctx, loadBalancerID, query) (\*[LoadBalancer](), error) GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/load\_balancers/{load\_balancer\_id} ##### [Create account or zone Load Balancer](https://developers.cloudflare.com/api/go/resources/load_balancers/methods/create) client.LoadBalancers.New(ctx, params) (\*[LoadBalancer](), error) POST/{accounts\_or\_zones}/{account\_or\_zone\_id}/load\_balancers ##### [Update account or zone Load Balancer](https://developers.cloudflare.com/api/go/resources/load_balancers/methods/update) client.LoadBalancers.Update(ctx, loadBalancerID, params) (\*[LoadBalancer](), error) PUT/{accounts\_or\_zones}/{account\_or\_zone\_id}/load\_balancers/{load\_balancer\_id} ##### [Patch account or zone Load Balancer](https://developers.cloudflare.com/api/go/resources/load_balancers/methods/edit) client.LoadBalancers.Edit(ctx, loadBalancerID, params) (\*[LoadBalancer](), error) PATCH/{accounts\_or\_zones}/{account\_or\_zone\_id}/load\_balancers/{load\_balancer\_id} ##### [Delete account or zone Load Balancer](https://developers.cloudflare.com/api/go/resources/load_balancers/methods/delete) client.LoadBalancers.Delete(ctx, loadBalancerID, body) (\*[LoadBalancerDeleteResponse](), error) DELETE/{accounts\_or\_zones}/{account\_or\_zone\_id}/load\_balancers/{load\_balancer\_id} ##### ModelsExpand Collapse
type AdaptiveRouting struct{…} 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. FailoverAcrossPools boolOptional 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](<#(resource)%20load_balancers%20%3E%20(model)%20adaptive_routing%20%3E%20(schema)>)
type CheckRegion string 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, CHINA: China (ENTERPRISE customers only), ALL\_REGIONS: all regions (ENTERPRISE customers only). One of the following: const CheckRegionWnam CheckRegion = "WNAM" Link to this property const CheckRegionEnam CheckRegion = "ENAM" Link to this property const CheckRegionWeu CheckRegion = "WEU" Link to this property const CheckRegionEeu CheckRegion = "EEU" Link to this property const CheckRegionNsam CheckRegion = "NSAM" Link to this property const CheckRegionSsam CheckRegion = "SSAM" Link to this property const CheckRegionOc CheckRegion = "OC" Link to this property const CheckRegionMe CheckRegion = "ME" Link to this property const CheckRegionNaf CheckRegion = "NAF" Link to this property const CheckRegionSaf CheckRegion = "SAF" Link to this property const CheckRegionSas CheckRegion = "SAS" Link to this property const CheckRegionSeas CheckRegion = "SEAS" Link to this property const CheckRegionNeas CheckRegion = "NEAS" Link to this property const CheckRegionChina CheckRegion = "CHINA" Link to this property const CheckRegionAllRegions CheckRegion = "ALL\_REGIONS" Link to this property
[Link to this property](<#(resource)%20load_balancers%20%3E%20(model)%20check_region%20%3E%20(schema)>) type DefaultPools string A pool ID. [Link to this property](<#(resource)%20load_balancers%20%3E%20(model)%20default_pools%20%3E%20(schema)>)
type FilterOptions struct{…} Filter options for a particular resource type (pool or origin). Use null to reset. Disable boolOptional If set true, disable notifications for this type of resource (pool or origin). Link to this property Healthy boolOptional If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events). Link to this property
[Link to this property](<#(resource)%20load_balancers%20%3E%20(model)%20filter_options%20%3E%20(schema)>)
type Header struct{…} The request header is used to pass additional information with an HTTP request. Currently supported header is ‘Host’. Host \[]HostOptional The ‘Host’ header allows to override the hostname set in the HTTP request. Current support is 1 ‘Host’ header override per origin. Link to this property
[Link to this property](<#(resource)%20load_balancers%20%3E%20(model)%20header%20%3E%20(schema)>) type Host string [Link to this property](<#(resource)%20load_balancers%20%3E%20(model)%20host%20%3E%20(schema)>)
type LoadBalancer struct{…} ID stringOptional Link to this property AdaptiveRouting AdaptiveRoutingOptional 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. Link to this property CountryPools map\[string, \[]string]Optional 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 CreatedOn stringOptional Link to this property DefaultPools \[]DefaultPoolsOptional 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 stringOptional Object description. Link to this property Enabled boolOptional Whether to enable (the default) this load balancer. Link to this property FallbackPool stringOptional The pool ID to use when all other pools are detected as unhealthy. Link to this property LocationStrategy LocationStrategyOptional Controls location-based steering for non-proxied requests. See steering_policy to learn how steering is affected. Link to this property ModifiedOn stringOptional Link to this property Name stringOptional 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 \[]stringOptional List of networks where Load Balancer or Pool is enabled. Link to this property
PoolSets \[]LoadBalancerPoolSetOptional 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 boolOptional Disable this specific pool set. It will no longer be evaluated. Link to this property
FixedResponse LoadBalancerPoolSetsFixedResponseOptional 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. ContentType stringOptional The http ‘Content-Type’ header to include in the response. maxLength32 Link to this property Location stringOptional The http ‘Location’ header to include in the response. maxLength2048 Link to this property MessageBody stringOptional Text to include as the http body. maxLength1024 Link to this property StatusCode int64Optional The http status code to respond with. Link to this property
Link to this property
Match LoadBalancerPoolSetsMatchOptional 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 boolOptional When true, matches every request. Cannot be combined with topology. Link to this property
Topology LoadBalancerPoolSetsMatchTopologyOptional 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 \[]stringOptional 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 \[]stringOptional A list of Cloudflare PoP codes. Matches when the request’s PoP is in this list. Link to this property Regions \[]stringOptional 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 stringOptional A human-readable name for this pool set. maxLength200 Link to this property
Overrides LoadBalancerPoolSetsOverridesOptional 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. FallbackPool stringOptional The pool ID to use when all other pools are detected as unhealthy. Link to this property PoolDefaultWeight float64Optional 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 PoolWeights map\[string, float64]Optional 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 \[]stringOptional 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 SteeringPolicy SteeringPolicyOptional 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". Link to this property
Link to this property
Link to this property POPPools map\[string, \[]string]Optional 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 boolOptional Whether the hostname should be gray clouded (false) or orange clouded (true). Link to this property RandomSteering RandomSteeringOptional 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. Link to this property RegionPools map\[string, \[]string]Optional 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 \[]RulesOptional BETA Field Not General Access: A list of rules for this load balancer to execute. Condition stringOptional 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 boolOptional Disable this specific rule. It will no longer be evaluated by this load balancer. Link to this property
FixedResponse RulesFixedResponseOptional 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. ContentType stringOptional The http ‘Content-Type’ header to include in the response. maxLength32 Link to this property Location stringOptional The http ‘Location’ header to include in the response. maxLength2048 Link to this property MessageBody stringOptional Text to include as the http body. maxLength1024 Link to this property StatusCode int64Optional The http status code to respond with. Link to this property
Link to this property Name stringOptional Name of this rule. Only used for human readability. maxLength200 Link to this property
Overrides RulesOverridesOptional A collection of overrides to apply when this rule’s condition (or a pool set’s match) is true. All fields are optional. AdaptiveRouting AdaptiveRoutingOptional 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. Link to this property CountryPools map\[string, \[]string]Optional 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 DefaultPools \[]DefaultPoolsOptional 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 FallbackPool stringOptional The pool ID to use when all other pools are detected as unhealthy. Link to this property LocationStrategy LocationStrategyOptional Controls location-based steering for non-proxied requests. See steering_policy to learn how steering is affected. Link to this property PoolDefaultWeight float64Optional 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 PoolWeights map\[string, float64]Optional 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 \[]stringOptional 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 POPPools map\[string, \[]string]Optional 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 RandomSteering RandomSteeringOptional 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. Link to this property RegionPools map\[string, \[]string]Optional 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 SessionAffinity SessionAffinityOptional 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. Link to this property SessionAffinityAttributes SessionAffinityAttributesOptional Configures attributes for session affinity. Link to this property SessionAffinityTTL float64Optional 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 SteeringPolicy SteeringPolicyOptional 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". Link to this property TTL float64Optional 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 int64Optional 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 boolOptional 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 SessionAffinity SessionAffinityOptional 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. Link to this property SessionAffinityAttributes SessionAffinityAttributesOptional Configures attributes for session affinity. Link to this property SessionAffinityTTL float64Optional 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 SteeringPolicy SteeringPolicyOptional 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". Link to this property TTL float64Optional 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 ZoneName stringOptional Link to this property
[Link to this property](<#(resource)%20load_balancers%20%3E%20(model)%20load_balancer%20%3E%20(schema)>)
type LoadShedding struct{…} Configures load shedding policies and percentages for the pool. DefaultPercent float64Optional The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity. maximum100 minimum0 Link to this property
DefaultPolicy LoadSheddingDefaultPolicyOptional 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. One of the following: const LoadSheddingDefaultPolicyRandom LoadSheddingDefaultPolicy = "random" Link to this property const LoadSheddingDefaultPolicyHash LoadSheddingDefaultPolicy = "hash" Link to this property
Link to this property SessionPercent float64Optional The percent of existing sessions to shed from the pool, according to the session policy. maximum100 minimum0 Link to this property SessionPolicy LoadSheddingSessionPolicyOptional Only the hash policy is supported for existing sessions (to avoid exponential decay). Link to this property
[Link to this property](<#(resource)%20load_balancers%20%3E%20(model)%20load_shedding%20%3E%20(schema)>)
type LocationStrategy struct{…} Controls location-based steering for non-proxied requests. See steering_policy to learn how steering is affected.
Mode LocationStrategyModeOptional 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: const LocationStrategyModePOP LocationStrategyMode = "pop" Link to this property const LocationStrategyModeResolverIP LocationStrategyMode = "resolver\_ip" Link to this property
Link to this property
PreferECS LocationStrategyPreferECSOptional 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: const LocationStrategyPreferECSAlways LocationStrategyPreferECS = "always" Link to this property const LocationStrategyPreferECSNever LocationStrategyPreferECS = "never" Link to this property const LocationStrategyPreferECSProximity LocationStrategyPreferECS = "proximity" Link to this property const LocationStrategyPreferECSGeo LocationStrategyPreferECS = "geo" Link to this property
Link to this property
[Link to this property](<#(resource)%20load_balancers%20%3E%20(model)%20location_strategy%20%3E%20(schema)>)
type NotificationFilter struct{…} Filter pool and origin health notifications by resource type or health status. Use null to reset. Origin FilterOptionsOptional Filter options for a particular resource type (pool or origin). Use null to reset. Link to this property Pool FilterOptionsOptional Filter options for a particular resource type (pool or origin). Use null to reset. Link to this property
[Link to this property](<#(resource)%20load_balancers%20%3E%20(model)%20notification_filter%20%3E%20(schema)>)
type Origin struct{…} Address stringOptional 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. Link to this property DisabledAt TimeOptional This field shows up only if the origin is disabled. This field is set with the time the origin was disabled. formatdate-time Link to this property Enabled boolOptional 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. Link to this property FlattenCNAME boolOptional Whether to flatten CNAME records for this origin, resolving them to A/AAAA records before returning to the client. When true (the default), the director resolves CNAME addresses to their underlying A/AAAA records. When false, the origin address is returned as a raw CNAME record without resolution. This setting mirrors the DNS API record flatten\_cname setting. Link to this property Header HeaderOptional The request header is used to pass additional information with an HTTP request. Currently supported header is ‘Host’. Link to this property Name stringOptional A human-identifiable name for the origin. Link to this property Port int64Optional The port for upstream connections. A value of 0 means the default port for the protocol will be used. Link to this property VirtualNetworkID stringOptional The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account. Link to this property Weight float64Optional 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. maximum1 minimum0 multipleOf0.01 Link to this property
[Link to this property](<#(resource)%20load_balancers%20%3E%20(model)%20origin%20%3E%20(schema)>)
type OriginSteering struct{…} Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.
Policy OriginSteeringPolicyOptional 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. One of the following: const OriginSteeringPolicyRandom OriginSteeringPolicy = "random" Link to this property const OriginSteeringPolicyHash OriginSteeringPolicy = "hash" Link to this property const OriginSteeringPolicyLeastOutstandingRequests OriginSteeringPolicy = "least\_outstanding\_requests" Link to this property const OriginSteeringPolicyLeastConnections OriginSteeringPolicy = "least\_connections" Link to this property
Link to this property
[Link to this property](<#(resource)%20load_balancers%20%3E%20(model)%20origin_steering%20%3E%20(schema)>)
type RandomSteering struct{…} 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. DefaultWeight float64Optional 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 PoolWeights map\[string, float64]Optional 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](<#(resource)%20load_balancers%20%3E%20(model)%20random_steering%20%3E%20(schema)>)
type Rules struct{…} A rule object containing conditions and overrides for this load balancer to evaluate. Condition stringOptional 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 boolOptional Disable this specific rule. It will no longer be evaluated by this load balancer. Link to this property
FixedResponse RulesFixedResponseOptional 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. ContentType stringOptional The http ‘Content-Type’ header to include in the response. maxLength32 Link to this property Location stringOptional The http ‘Location’ header to include in the response. maxLength2048 Link to this property MessageBody stringOptional Text to include as the http body. maxLength1024 Link to this property StatusCode int64Optional The http status code to respond with. Link to this property
Link to this property Name stringOptional Name of this rule. Only used for human readability. maxLength200 Link to this property
Overrides RulesOverridesOptional A collection of overrides to apply when this rule’s condition (or a pool set’s match) is true. All fields are optional. AdaptiveRouting AdaptiveRoutingOptional 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. Link to this property CountryPools map\[string, \[]string]Optional 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 DefaultPools \[]DefaultPoolsOptional 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 FallbackPool stringOptional The pool ID to use when all other pools are detected as unhealthy. Link to this property LocationStrategy LocationStrategyOptional Controls location-based steering for non-proxied requests. See steering_policy to learn how steering is affected. Link to this property PoolDefaultWeight float64Optional 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 PoolWeights map\[string, float64]Optional 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 \[]stringOptional 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 POPPools map\[string, \[]string]Optional 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 RandomSteering RandomSteeringOptional 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. Link to this property RegionPools map\[string, \[]string]Optional 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 SessionAffinity SessionAffinityOptional 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. Link to this property SessionAffinityAttributes SessionAffinityAttributesOptional Configures attributes for session affinity. Link to this property SessionAffinityTTL float64Optional 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 SteeringPolicy SteeringPolicyOptional 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". Link to this property TTL float64Optional 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 int64Optional 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 boolOptional 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](<#(resource)%20load_balancers%20%3E%20(model)%20rules%20%3E%20(schema)>)
type SessionAffinity string 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: const SessionAffinityNone SessionAffinity = "none" Link to this property const SessionAffinityCookie SessionAffinity = "cookie" Link to this property const SessionAffinityIPCookie SessionAffinity = "ip\_cookie" Link to this property const SessionAffinityHeader SessionAffinity = "header" Link to this property
[Link to this property](<#(resource)%20load_balancers%20%3E%20(model)%20session_affinity%20%3E%20(schema)>)
type SessionAffinityAttributes struct{…} Configures attributes for session affinity. DrainDuration float64Optional 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 \[]stringOptional 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 RequireAllHeaders boolOptional 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 SessionAffinityAttributesSamesiteOptional 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: const SessionAffinityAttributesSamesiteAuto SessionAffinityAttributesSamesite = "Auto" Link to this property const SessionAffinityAttributesSamesiteLax SessionAffinityAttributesSamesite = "Lax" Link to this property const SessionAffinityAttributesSamesiteNone SessionAffinityAttributesSamesite = "None" Link to this property const SessionAffinityAttributesSamesiteStrict SessionAffinityAttributesSamesite = "Strict" Link to this property
Link to this property
Secure SessionAffinityAttributesSecureOptional 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: const SessionAffinityAttributesSecureAuto SessionAffinityAttributesSecure = "Auto" Link to this property const SessionAffinityAttributesSecureAlways SessionAffinityAttributesSecure = "Always" Link to this property const SessionAffinityAttributesSecureNever SessionAffinityAttributesSecure = "Never" Link to this property
Link to this property
ZeroDowntimeFailover SessionAffinityAttributesZeroDowntimeFailoverOptional 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: const SessionAffinityAttributesZeroDowntimeFailoverNone SessionAffinityAttributesZeroDowntimeFailover = "none" Link to this property const SessionAffinityAttributesZeroDowntimeFailoverTemporary SessionAffinityAttributesZeroDowntimeFailover = "temporary" Link to this property const SessionAffinityAttributesZeroDowntimeFailoverSticky SessionAffinityAttributesZeroDowntimeFailover = "sticky" Link to this property
Link to this property
[Link to this property](<#(resource)%20load_balancers%20%3E%20(model)%20session_affinity_attributes%20%3E%20(schema)>)
type SteeringPolicy string 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: const SteeringPolicyOff SteeringPolicy = "off" Link to this property const SteeringPolicyGeo SteeringPolicy = "geo" Link to this property const SteeringPolicyRandom SteeringPolicy = "random" Link to this property const SteeringPolicyDynamicLatency SteeringPolicy = "dynamic\_latency" Link to this property const SteeringPolicyProximity SteeringPolicy = "proximity" Link to this property const SteeringPolicyLeastOutstandingRequests SteeringPolicy = "least\_outstanding\_requests" Link to this property const SteeringPolicyLeastConnections SteeringPolicy = "least\_connections" Link to this property const SteeringPolicyEmpty SteeringPolicy = "" Link to this property
[Link to this property](<#(resource)%20load_balancers%20%3E%20(model)%20steering_policy%20%3E%20(schema)>) #### Load BalancersMonitors ##### [List Monitors](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/monitors/methods/list) client.LoadBalancers.Monitors.List(ctx, query) (\*SinglePage\[[Monitor]()], error) GET/accounts/{account\_id}/load\_balancers/monitors ##### [Monitor Details](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/monitors/methods/get) client.LoadBalancers.Monitors.Get(ctx, monitorID, query) (\*[Monitor](), error) GET/accounts/{account\_id}/load\_balancers/monitors/{monitor\_id} ##### [Create Monitor](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/monitors/methods/create) client.LoadBalancers.Monitors.New(ctx, params) (\*[Monitor](), error) POST/accounts/{account\_id}/load\_balancers/monitors ##### [Update Monitor](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/monitors/methods/update) client.LoadBalancers.Monitors.Update(ctx, monitorID, params) (\*[Monitor](), error) PUT/accounts/{account\_id}/load\_balancers/monitors/{monitor\_id} ##### [Patch Monitor](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/monitors/methods/edit) client.LoadBalancers.Monitors.Edit(ctx, monitorID, params) (\*[Monitor](), error) PATCH/accounts/{account\_id}/load\_balancers/monitors/{monitor\_id} ##### [Delete Monitor](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/monitors/methods/delete) client.LoadBalancers.Monitors.Delete(ctx, monitorID, body) (\*[MonitorDeleteResponse](), error) DELETE/accounts/{account\_id}/load\_balancers/monitors/{monitor\_id} ##### ModelsExpand Collapse
type Monitor struct{…} ID stringOptional Link to this property AllowInsecure boolOptional Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors. Link to this property ConsecutiveDown int64Optional To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Link to this property ConsecutiveUp int64Optional To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Link to this property CreatedOn stringOptional Link to this property Description stringOptional Object description. Link to this property ExpectedBody stringOptional 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. Link to this property ExpectedCodes stringOptional The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors. Link to this property FollowRedirects boolOptional Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors. Link to this property Header map\[string, \[]string]Optional 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. Link to this property Interval int64Optional 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. Link to this property Method stringOptional 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. Link to this property ModifiedOn stringOptional Link to this property Path stringOptional The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors. Link to this property Port int64Optional 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). Link to this property ProbeZone stringOptional Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors. Link to this property Retries int64Optional The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. Link to this property Timeout int64Optional The timeout (in seconds) before marking the health check as failed. Link to this property
Type MonitorTypeOptional The protocol to use for the health check. Currently supported protocols are ‘HTTP’,‘HTTPS’, ‘TCP’, ‘ICMP-PING’, ‘UDP-ICMP’, and ‘SMTP’. One of the following: const MonitorTypeHTTP MonitorType = "http" Link to this property const MonitorTypeHTTPS MonitorType = "https" Link to this property const MonitorTypeTCP MonitorType = "tcp" Link to this property const MonitorTypeUdpIcmp MonitorType = "udp\_icmp" Link to this property const MonitorTypeIcmpPing MonitorType = "icmp\_ping" Link to this property const MonitorTypeSmtp MonitorType = "smtp" Link to this property
Link to this property
[Link to this property](<#(resource)%20load_balancers.monitors%20%3E%20(model)%20monitor%20%3E%20(schema)>) #### Load BalancersMonitorsPreviews ##### [Preview Monitor](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/monitors/subresources/previews/methods/create) client.LoadBalancers.Monitors.Previews.New(ctx, monitorID, params) (\*[MonitorPreviewNewResponse](), error) POST/accounts/{account\_id}/load\_balancers/monitors/{monitor\_id}/preview #### Load BalancersMonitorsReferences ##### [List Monitor References](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/monitors/subresources/references/methods/get) client.LoadBalancers.Monitors.References.Get(ctx, monitorID, query) (\*SinglePage\[[MonitorReferenceGetResponse]()], error) GET/accounts/{account\_id}/load\_balancers/monitors/{monitor\_id}/references #### Load BalancersMonitor Groups ##### [List Monitor Groups](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/monitor_groups/methods/list) client.LoadBalancers.MonitorGroups.List(ctx, query) (\*SinglePage\[[MonitorGroup]()], error) GET/accounts/{account\_id}/load\_balancers/monitor\_groups ##### [Monitor Group Details](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/monitor_groups/methods/get) client.LoadBalancers.MonitorGroups.Get(ctx, monitorGroupID, query) (\*[MonitorGroup](), error) GET/accounts/{account\_id}/load\_balancers/monitor\_groups/{monitor\_group\_id} ##### [Create Monitor Group](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/monitor_groups/methods/create) client.LoadBalancers.MonitorGroups.New(ctx, params) (\*[MonitorGroup](), error) POST/accounts/{account\_id}/load\_balancers/monitor\_groups ##### [Update Monitor Group](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/monitor_groups/methods/update) client.LoadBalancers.MonitorGroups.Update(ctx, monitorGroupID, params) (\*[MonitorGroup](), error) PUT/accounts/{account\_id}/load\_balancers/monitor\_groups/{monitor\_group\_id} ##### [Patch Monitor Group](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/monitor_groups/methods/edit) client.LoadBalancers.MonitorGroups.Edit(ctx, monitorGroupID, params) (\*[MonitorGroup](), error) PATCH/accounts/{account\_id}/load\_balancers/monitor\_groups/{monitor\_group\_id} ##### [Delete Monitor Group](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/monitor_groups/methods/delete) client.LoadBalancers.MonitorGroups.Delete(ctx, monitorGroupID, body) (\*[MonitorGroup](), error) DELETE/accounts/{account\_id}/load\_balancers/monitor\_groups/{monitor\_group\_id} ##### ModelsExpand Collapse
type MonitorGroup struct{…} ID string The ID of the Monitor Group to use for checking the health of origins within this pool. Link to this property Description string A short description of the monitor group Link to this property
Members \[]MonitorGroupMember List of monitors in this group Enabled bool Whether this monitor is enabled in the group Link to this property MonitorID string The ID of the Monitor to use for checking the health of origins within this pool. Link to this property MonitoringOnly bool Whether this monitor is used for monitoring only (does not affect pool health) Link to this property MustBeHealthy bool Whether this monitor must be healthy for the pool to be considered healthy Link to this property CreatedAt TimeOptional The timestamp of when the monitor was added to the group formatdate-time Link to this property UpdatedAt TimeOptional The timestamp of when the monitor group member was last updated formatdate-time Link to this property
Link to this property CreatedOn TimeOptional The timestamp of when the monitor group was created formatdate-time Link to this property ModifiedOn TimeOptional The timestamp of when the monitor group was last updated formatdate-time Link to this property
[Link to this property](<#(resource)%20load_balancers.monitor_groups%20%3E%20(model)%20monitor_group%20%3E%20(schema)>) #### Load BalancersMonitor GroupsReferences ##### [List Monitor Group References](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/monitor_groups/subresources/references/methods/get) client.LoadBalancers.MonitorGroups.References.Get(ctx, monitorGroupID, query) (\*SinglePage\[[MonitorGroupReferenceGetResponse]()], error) GET/accounts/{account\_id}/load\_balancers/monitor\_groups/{monitor\_group\_id}/references #### Load BalancersPools ##### [List Pools](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/pools/methods/list) client.LoadBalancers.Pools.List(ctx, params) (\*SinglePage\[[Pool]()], error) GET/accounts/{account\_id}/load\_balancers/pools ##### [Pool Details](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/pools/methods/get) client.LoadBalancers.Pools.Get(ctx, poolID, query) (\*[Pool](), error) GET/accounts/{account\_id}/load\_balancers/pools/{pool\_id} ##### [Create Pool](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/pools/methods/create) client.LoadBalancers.Pools.New(ctx, params) (\*[Pool](), error) POST/accounts/{account\_id}/load\_balancers/pools ##### [Update Pool](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/pools/methods/update) client.LoadBalancers.Pools.Update(ctx, poolID, params) (\*[Pool](), error) PUT/accounts/{account\_id}/load\_balancers/pools/{pool\_id} ##### [Patch Pool](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/pools/methods/edit) client.LoadBalancers.Pools.Edit(ctx, poolID, params) (\*[Pool](), error) PATCH/accounts/{account\_id}/load\_balancers/pools/{pool\_id} ##### [Delete Pool](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/pools/methods/delete) client.LoadBalancers.Pools.Delete(ctx, poolID, body) (\*[PoolDeleteResponse](), error) DELETE/accounts/{account\_id}/load\_balancers/pools/{pool\_id} ##### [Patch Pools](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/pools/methods/bulk_edit) client.LoadBalancers.Pools.BulkEdit(ctx, params) (\*SinglePage\[[Pool]()], error) PATCH/accounts/{account\_id}/load\_balancers/pools ##### ModelsExpand Collapse
type Pool struct{…} ID stringOptional Link to this property
CheckRegions \[]CheckRegionOptional A list of regions from which to run health checks. Null means every Cloudflare data center. One of the following: const CheckRegionWnam CheckRegion = "WNAM" Link to this property const CheckRegionEnam CheckRegion = "ENAM" Link to this property const CheckRegionWeu CheckRegion = "WEU" Link to this property const CheckRegionEeu CheckRegion = "EEU" Link to this property const CheckRegionNsam CheckRegion = "NSAM" Link to this property const CheckRegionSsam CheckRegion = "SSAM" Link to this property const CheckRegionOc CheckRegion = "OC" Link to this property const CheckRegionMe CheckRegion = "ME" Link to this property const CheckRegionNaf CheckRegion = "NAF" Link to this property const CheckRegionSaf CheckRegion = "SAF" Link to this property const CheckRegionSas CheckRegion = "SAS" Link to this property const CheckRegionSeas CheckRegion = "SEAS" Link to this property const CheckRegionNeas CheckRegion = "NEAS" Link to this property const CheckRegionChina CheckRegion = "CHINA" Link to this property const CheckRegionAllRegions CheckRegion = "ALL\_REGIONS" Link to this property
Link to this property CreatedOn stringOptional Link to this property Description stringOptional A human-readable description of the pool. Link to this property DisabledAt TimeOptional This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at. formatdate-time Link to this property Enabled boolOptional 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). Link to this property
HealthSources \[]PoolHealthSourceOptional A list of health sources, ordered from highest to lowest priority, used to evaluate individual origin health and overall pool health. The load balancer uses the first source that has data and falls back to the next. Currently accepted values are null or the exact array \[“regional”, “global”]; any other combination is rejected. Null (the default) behaves like \[“local”, “global”]. \[“regional”, “global”] makes each region steer on its own health, falling back to the global decision when a region has no fresh data. Setting regional requires at least one region in check\_regions. One of the following: const PoolHealthSourceLocal PoolHealthSource = "local" Link to this property const PoolHealthSourceRegional PoolHealthSource = "regional" Link to this property const PoolHealthSourceGlobal PoolHealthSource = "global" Link to this property
Link to this property Latitude float64Optional 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. Link to this property LoadShedding LoadSheddingOptional Configures load shedding policies and percentages for the pool. Link to this property Longitude float64Optional 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. Link to this property MinimumOrigins int64Optional 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. Link to this property ModifiedOn stringOptional Link to this property Monitor stringOptional The ID of the Monitor to use for checking the health of origins within this pool. Link to this property MonitorGroup stringOptional The ID of the Monitor Group to use for checking the health of origins within this pool. Link to this property Name stringOptional A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed. Link to this property Networks \[]stringOptional List of networks where Load Balancer or Pool is enabled. Link to this property NotificationEmail stringOptional 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. Link to this property NotificationFilter NotificationFilterOptional Filter pool and origin health notifications by resource type or health status. Use null to reset. Link to this property OriginSteering OriginSteeringOptional Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity. Link to this property
Origins \[]OriginOptional 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 stringOptional 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. Link to this property DisabledAt TimeOptional This field shows up only if the origin is disabled. This field is set with the time the origin was disabled. formatdate-time Link to this property Enabled boolOptional 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. Link to this property FlattenCNAME boolOptional Whether to flatten CNAME records for this origin, resolving them to A/AAAA records before returning to the client. When true (the default), the director resolves CNAME addresses to their underlying A/AAAA records. When false, the origin address is returned as a raw CNAME record without resolution. This setting mirrors the DNS API record flatten\_cname setting. Link to this property Header HeaderOptional The request header is used to pass additional information with an HTTP request. Currently supported header is ‘Host’. Link to this property Name stringOptional A human-identifiable name for the origin. Link to this property Port int64Optional The port for upstream connections. A value of 0 means the default port for the protocol will be used. Link to this property VirtualNetworkID stringOptional The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account. Link to this property Weight float64Optional 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. maximum1 minimum0 multipleOf0.01 Link to this property
Link to this property
[Link to this property](<#(resource)%20load_balancers.pools%20%3E%20(model)%20pool%20%3E%20(schema)>) #### Load BalancersPoolsHealth ##### [Pool Health Details](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/pools/subresources/health/methods/get) client.LoadBalancers.Pools.Health.Get(ctx, poolID, query) (\*[PoolHealthGetResponse](), error) GET/accounts/{account\_id}/load\_balancers/pools/{pool\_id}/health ##### [Preview Pool](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/pools/subresources/health/methods/create) client.LoadBalancers.Pools.Health.New(ctx, poolID, params) (\*[PoolHealthNewResponse](), error) POST/accounts/{account\_id}/load\_balancers/pools/{pool\_id}/preview #### Load BalancersPoolsReferences ##### [List Pool References](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/pools/subresources/references/methods/get) client.LoadBalancers.Pools.References.Get(ctx, poolID, query) (\*SinglePage\[[PoolReferenceGetResponse]()], error) GET/accounts/{account\_id}/load\_balancers/pools/{pool\_id}/references #### Load BalancersPreviews ##### [Preview Result](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/previews/methods/get) client.LoadBalancers.Previews.Get(ctx, previewID, query) (\*[PreviewGetResponse](), error) GET/accounts/{account\_id}/load\_balancers/preview/{preview\_id} #### Load BalancersRegions ##### [List Regions](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/regions/methods/list) client.LoadBalancers.Regions.List(ctx, params) (\*unknown, error) GET/accounts/{account\_id}/load\_balancers/regions ##### [Get Region](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/regions/methods/get) client.LoadBalancers.Regions.Get(ctx, regionID, query) (\*unknown, error) GET/accounts/{account\_id}/load\_balancers/regions/{region\_id} #### Load BalancersSearches ##### [Search Resources](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/searches/methods/list) client.LoadBalancers.Searches.List(ctx, params) (\*V4PagePagination\[[SearchListResponse]()], error) GET/accounts/{account\_id}/load\_balancers/search