--- title: Update Pool --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Load Balancers](https://developers.cloudflare.com/api/go/resources/load_balancers) [Pools](https://developers.cloudflare.com/api/go/resources/load_balancers/subresources/pools) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Update Pool client.LoadBalancers.Pools.Update(ctx, poolID, params) (\*[Pool](), error) PUT/accounts/{account\_id}/load\_balancers/pools/{pool\_id} Modify a configured pool. ##### 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 Balancing: Monitors and Pools Write` ##### ParametersExpand Collapse poolID string [Link to this property](<#(resource)%20load_balancers.pools%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20pool_id%20%3E%20(schema)>)

params PoolUpdateParams

AccountID param.Field\[string] Path param: Identifier. maxLength32 Link to this property Name param.Field\[string] Body param: A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed. Link to this property

Origins param.Field\[\[]Origin] Body param: 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’.

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 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

CheckRegions param.Field\[\[]CheckRegion]Optional Body param: A list of regions from which to run health checks. Null means every Cloudflare data center.

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 Description param.Field\[string]Optional Body param: A human-readable description of the pool. Link to this property Enabled param.Field\[bool]Optional Body param: 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 param.Field\[\[]PoolUpdateParamsHealthSource]Optional Body param: 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.

const PoolUpdateParamsHealthSourceLocal PoolUpdateParamsHealthSource = "local" Link to this property const PoolUpdateParamsHealthSourceRegional PoolUpdateParamsHealthSource = "regional" Link to this property const PoolUpdateParamsHealthSourceGlobal PoolUpdateParamsHealthSource = "global" Link to this property

Link to this property Latitude param.Field\[float64]Optional Body param: 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 param.Field\[LoadShedding]Optional Body param: Configures load shedding policies and percentages for the pool. Link to this property Longitude param.Field\[float64]Optional Body param: 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 param.Field\[int64]Optional Body param: 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 Monitor param.Field\[string]Optional Body param: The ID of the Monitor to use for checking the health of origins within this pool. Link to this property MonitorGroup param.Field\[string]Optional Body param: The ID of the Monitor Group to use for checking the health of origins within this pool. Link to this property NotificationEmail param.Field\[string]Optional Body param: 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 param.Field\[NotificationFilter]Optional Body param: Filter pool and origin health notifications by resource type or health status. Use null to reset. Link to this property OriginSteering param.Field\[OriginSteering]Optional Body param: Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity. Link to this property

[Link to this property](<#(resource)%20load_balancers.pools%20%3E%20(method)%20update%20%3E%20(params)%20default>) ##### ReturnsExpand 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.

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 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.

Origin FilterOptionsOptional 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

Pool FilterOptionsOptional Filter options for a particular resource type (pool or origin). 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.

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

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.

Header HeaderOptional 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

[Link to this property](<#(resource)%20load_balancers.pools%20%3E%20(model)%20pool%20%3E%20(schema)>) ### Update Pool Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/load_balancers" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) pool, err := client.LoadBalancers.Pools.Update( context.TODO(), "17b5962d775c646f3f9725cbc7a53df4", load_balancers.PoolUpdateParams{ AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), Name: cloudflare.F("primary-dc-1"), Origins: cloudflare.F([]load_balancers.OriginParam{load_balancers.OriginParam{ }}), }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", pool.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": "17b5962d775c646f3f9725cbc7a53df4", "check_regions": [ "WEU", "ENAM" ], "created_on": "2014-01-01T05:20:00.12345Z", "description": "Primary data center - Provider XYZ", "disabled_at": "2019-12-27T18:11:19.117Z", "enabled": false, "health_sources": [ "regional", "global" ], "latitude": 0, "load_shedding": { "default_percent": 0, "default_policy": "random", "session_percent": 0, "session_policy": "hash" }, "longitude": 0, "minimum_origins": 0, "modified_on": "2014-01-01T05:20:00.12345Z", "monitor": "monitor", "monitor_group": "monitor_group", "name": "primary-dc-1", "networks": [ "string" ], "notification_email": "someone@example.com,sometwo@example.com", "notification_filter": { "origin": { "disable": true, "healthy": true }, "pool": { "disable": true, "healthy": false } }, "origin_steering": { "policy": "random" }, "origins": [ { "address": "0.0.0.0", "disabled_at": "2019-12-27T18:11:19.117Z", "enabled": true, "flatten_cname": true, "header": { "Host": [ "example.com" ] }, "name": "app-server-1", "port": 0, "virtual_network_id": "a5624d4e-044a-4ff0-b3e1-e2465353d4b4", "weight": 0.6 } ] }, "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": "17b5962d775c646f3f9725cbc7a53df4", "check_regions": [ "WEU", "ENAM" ], "created_on": "2014-01-01T05:20:00.12345Z", "description": "Primary data center - Provider XYZ", "disabled_at": "2019-12-27T18:11:19.117Z", "enabled": false, "health_sources": [ "regional", "global" ], "latitude": 0, "load_shedding": { "default_percent": 0, "default_policy": "random", "session_percent": 0, "session_policy": "hash" }, "longitude": 0, "minimum_origins": 0, "modified_on": "2014-01-01T05:20:00.12345Z", "monitor": "monitor", "monitor_group": "monitor_group", "name": "primary-dc-1", "networks": [ "string" ], "notification_email": "someone@example.com,sometwo@example.com", "notification_filter": { "origin": { "disable": true, "healthy": true }, "pool": { "disable": true, "healthy": false } }, "origin_steering": { "policy": "random" }, "origins": [ { "address": "0.0.0.0", "disabled_at": "2019-12-27T18:11:19.117Z", "enabled": true, "flatten_cname": true, "header": { "Host": [ "example.com" ] }, "name": "app-server-1", "port": 0, "virtual_network_id": "a5624d4e-044a-4ff0-b3e1-e2465353d4b4", "weight": 0.6 } ] }, "success": true } ```