Cloudflare/load Balancing

@webframp/cloudflare/load-balancingv2026.08.21.2· 1d agoMODELS

01README

Cloudflare Load Balancing — pools, monitors, load balancers, steering policies

02Release Notes

2026.08.21.2

Changed:

Errors raised when a Cloudflare API call fails now name the HTTP method and path that was attempted (e.g. Cloudflare API POST /accounts/.../load_balancers/monitors failed with HTTP 400 ...) instead of a bare Cloudflare API error: .... Network-level failures (DNS, connection reset, timeout) are now also caught and wrapped with the same operation context instead of surfacing a raw fetch error.

No breaking changes.

03Models1

cloudflare/load_balancing.tsv2026.07.27.1

Global Arguments

Argument	Type	Required	Description
apiToken	string	yes	Cloudflare API token
accountId	string	yes	Cloudflare account ID

fn list_account_load_balancers()

List Account Load Balancers

fn create_account_load_balancer(adaptive_routing?: unknown, country_pools?: unknown, default_pools: unknown, description?: unknown, enabled?: unknown, fallback_pool: unknown, location_strategy?: unknown, name: unknown, networks?: unknown, pop_pools?: unknown, proxied?: unknown, random_steering?: unknown, region_pools?: unknown, rules?: unknown, session_affinity?: unknown, session_affinity_attributes?: unknown, session_affinity_ttl?: unknown, steering_policy?: unknown, ttl?: unknown)

Create Account Load Balancer

Argument	Type	Required
adaptive_routing?	unknown	no
country_pools?	unknown	no
default_pools	unknown	yes
description?	unknown	no
enabled?	unknown	no
fallback_pool	unknown	yes
location_strategy?	unknown	no
name	unknown	yes
networks?	unknown	no
pop_pools?	unknown	no
proxied?	unknown	no
random_steering?	unknown	no
region_pools?	unknown	no
rules?	unknown	no
session_affinity?	unknown	no
session_affinity_attributes?	unknown	no
session_affinity_ttl?	unknown	no
steering_policy?	unknown	no
ttl?	unknown	no

fn list_monitor_groups()

List Monitor Groups

fn create_monitor_group(created_on?: string, description: string, members: array, modified_on?: string)

Create Monitor Group

Argument	Type	Required	Description
created_on?	string	no	The timestamp of when the monitor group was created
description	string	yes	A short description of the monitor group
members	array	yes	List of monitors in this group
modified_on?	string	no	The timestamp of when the monitor group was last updated

fn get_account_load_balancer_monitor_groups_monitor_group_details(monitor_group_id: string)

Monitor Group Details

Argument	Type	Required	Description
monitor_group_id	string	yes	Monitor group identifier.

fn update_monitor_group(monitor_group_id: string, created_on?: string, description: string, members: array, modified_on?: string)

Update Monitor Group

Argument	Type	Required	Description
monitor_group_id	string	yes	Monitor group identifier.
created_on?	string	no	The timestamp of when the monitor group was created
description	string	yes	A short description of the monitor group
members	array	yes	List of monitors in this group
modified_on?	string	no	The timestamp of when the monitor group was last updated

fn patch_monitor_group(monitor_group_id: string, created_on?: string, description: string, members: array, modified_on?: string)

Patch Monitor Group

Argument	Type	Required	Description
monitor_group_id	string	yes	Monitor group identifier.
created_on?	string	no	The timestamp of when the monitor group was created
description	string	yes	A short description of the monitor group
members	array	yes	List of monitors in this group
modified_on?	string	no	The timestamp of when the monitor group was last updated

fn delete_monitor_group(monitor_group_id: string)

Delete Monitor Group

Argument	Type	Required	Description
monitor_group_id	string	yes	Monitor group identifier.

fn list_monitor_group_references(monitor_group_id: string)

List Monitor Group References

Argument	Type	Required	Description
monitor_group_id	string	yes	Monitor group identifier.

fn list_monitors()

List Monitors

fn create_monitor(allow_insecure?: unknown, consecutive_down?: unknown, consecutive_up?: unknown, description?: unknown, expected_body?: unknown, expected_codes?: unknown, follow_redirects?: unknown, header?: unknown, interval?: unknown, method?: unknown, path?: unknown, port?: unknown, probe_zone?: unknown, retries?: unknown, timeout?: unknown, type?: unknown)

Create Monitor

Argument	Type	Required
allow_insecure?	unknown	no
consecutive_down?	unknown	no
consecutive_up?	unknown	no
description?	unknown	no
expected_body?	unknown	no
expected_codes?	unknown	no
follow_redirects?	unknown	no
header?	unknown	no
interval?	unknown	no
method?	unknown	no
path?	unknown	no
port?	unknown	no
probe_zone?	unknown	no
retries?	unknown	no
timeout?	unknown	no
type?	unknown	no

fn get_account_load_balancer_monitors_monitor_details(monitor_id: string)

Monitor Details

Argument	Type	Required	Description
monitor_id	string	yes	Monitor identifier.

fn update_monitor(monitor_id: string, allow_insecure?: unknown, consecutive_down?: unknown, consecutive_up?: unknown, description?: unknown, expected_body?: unknown, expected_codes?: unknown, follow_redirects?: unknown, header?: unknown, interval?: unknown, method?: unknown, path?: unknown, port?: unknown, probe_zone?: unknown, retries?: unknown, timeout?: unknown, type?: unknown)

Update Monitor

Argument	Type	Required	Description
monitor_id	string	yes	Monitor identifier.
allow_insecure?	unknown	no
consecutive_down?	unknown	no
consecutive_up?	unknown	no
description?	unknown	no
expected_body?	unknown	no
expected_codes?	unknown	no
follow_redirects?	unknown	no
header?	unknown	no
interval?	unknown	no
method?	unknown	no
path?	unknown	no
port?	unknown	no
probe_zone?	unknown	no
retries?	unknown	no
timeout?	unknown	no
type?	unknown	no

fn patch_monitor(monitor_id: string, allow_insecure?: unknown, consecutive_down?: unknown, consecutive_up?: unknown, description?: unknown, expected_body?: unknown, expected_codes?: unknown, follow_redirects?: unknown, header?: unknown, interval?: unknown, method?: unknown, path?: unknown, port?: unknown, probe_zone?: unknown, retries?: unknown, timeout?: unknown, type?: unknown)

Patch Monitor

Argument	Type	Required	Description
monitor_id	string	yes	Monitor identifier.
allow_insecure?	unknown	no
consecutive_down?	unknown	no
consecutive_up?	unknown	no
description?	unknown	no
expected_body?	unknown	no
expected_codes?	unknown	no
follow_redirects?	unknown	no
header?	unknown	no
interval?	unknown	no
method?	unknown	no
path?	unknown	no
port?	unknown	no
probe_zone?	unknown	no
retries?	unknown	no
timeout?	unknown	no
type?	unknown	no

fn delete_monitor(monitor_id: string)

Delete Monitor

Argument	Type	Required	Description
monitor_id	string	yes	Monitor identifier.

fn create_account_load_balancer_monitors_preview_monitor(monitor_id: string, allow_insecure?: unknown, consecutive_down?: unknown, consecutive_up?: unknown, description?: unknown, expected_body?: unknown, expected_codes?: unknown, follow_redirects?: unknown, header?: unknown, interval?: unknown, method?: unknown, path?: unknown, port?: unknown, probe_zone?: unknown, retries?: unknown, timeout?: unknown, type?: unknown)

Preview Monitor

Argument	Type	Required	Description
monitor_id	string	yes	Monitor identifier.
allow_insecure?	unknown	no
consecutive_down?	unknown	no
consecutive_up?	unknown	no
description?	unknown	no
expected_body?	unknown	no
expected_codes?	unknown	no
follow_redirects?	unknown	no
header?	unknown	no
interval?	unknown	no
method?	unknown	no
path?	unknown	no
port?	unknown	no
probe_zone?	unknown	no
retries?	unknown	no
timeout?	unknown	no
type?	unknown	no

fn list_monitor_references(monitor_id: string)

List Monitor References

Argument	Type	Required	Description
monitor_id	string	yes	Monitor identifier.

fn list_pools(monitor?: string)

List Pools

Argument	Type	Required	Description
monitor?	string	no

fn create_pool(description?: unknown, enabled?: unknown, latitude?: unknown, load_shedding?: unknown, longitude?: unknown, minimum_origins?: unknown, monitor?: unknown, monitor_group?: unknown, name: unknown, notification_email?: unknown, notification_filter?: unknown, origin_steering?: unknown, origins: unknown)

Create Pool

Argument	Type	Required
description?	unknown	no
enabled?	unknown	no
latitude?	unknown	no
load_shedding?	unknown	no
longitude?	unknown	no
minimum_origins?	unknown	no
monitor?	unknown	no
monitor_group?	unknown	no
name	unknown	yes
notification_email?	unknown	no
notification_filter?	unknown	no
origin_steering?	unknown	no
origins	unknown	yes

fn patch_pools(notification_email?: unknown)

Patch Pools

Argument	Type	Required	Description
notification_email?	unknown	no

fn get_account_load_balancer_pools_pool_details(pool_id: string)

Pool Details

Argument	Type	Required	Description
pool_id	string	yes	Pool identifier.

fn update_pool(pool_id: string, check_regions?: unknown, description?: unknown, disabled_at?: unknown, enabled?: unknown, latitude?: unknown, load_shedding?: unknown, longitude?: unknown, minimum_origins?: unknown, monitor?: unknown, monitor_group?: unknown, name: unknown, notification_email?: unknown, notification_filter?: unknown, origin_steering?: unknown, origins: unknown)

Update Pool

Argument	Type	Required	Description
pool_id	string	yes	Pool identifier.
check_regions?	unknown	no
description?	unknown	no
disabled_at?	unknown	no
enabled?	unknown	no
latitude?	unknown	no
load_shedding?	unknown	no
longitude?	unknown	no
minimum_origins?	unknown	no
monitor?	unknown	no
monitor_group?	unknown	no
name	unknown	yes
notification_email?	unknown	no
notification_filter?	unknown	no
origin_steering?	unknown	no
origins	unknown	yes

fn patch_pool(pool_id: string, check_regions?: unknown, description?: unknown, disabled_at?: unknown, enabled?: unknown, latitude?: unknown, load_shedding?: unknown, longitude?: unknown, minimum_origins?: unknown, monitor?: unknown, monitor_group?: unknown, name?: unknown, notification_email?: unknown, notification_filter?: unknown, origin_steering?: unknown, origins?: unknown)

Patch Pool

Argument	Type	Required	Description
pool_id	string	yes	Pool identifier.
check_regions?	unknown	no
description?	unknown	no
disabled_at?	unknown	no
enabled?	unknown	no
latitude?	unknown	no
load_shedding?	unknown	no
longitude?	unknown	no
minimum_origins?	unknown	no
monitor?	unknown	no
monitor_group?	unknown	no
name?	unknown	no
notification_email?	unknown	no
notification_filter?	unknown	no
origin_steering?	unknown	no
origins?	unknown	no

fn delete_pool(pool_id: string)

Delete Pool

Argument	Type	Required	Description
pool_id	string	yes	Pool identifier.

fn get_account_load_balancer_pools_pool_health_details(pool_id: string)

Pool Health Details

Argument	Type	Required	Description
pool_id	string	yes	Pool identifier.

fn create_account_load_balancer_pools_preview_pool(pool_id: string, allow_insecure?: unknown, consecutive_down?: unknown, consecutive_up?: unknown, description?: unknown, expected_body?: unknown, expected_codes?: unknown, follow_redirects?: unknown, header?: unknown, interval?: unknown, method?: unknown, path?: unknown, port?: unknown, probe_zone?: unknown, retries?: unknown, timeout?: unknown, type?: unknown)

Preview Pool

Argument	Type	Required	Description
pool_id	string	yes	Pool identifier.
allow_insecure?	unknown	no
consecutive_down?	unknown	no
consecutive_up?	unknown	no
description?	unknown	no
expected_body?	unknown	no
expected_codes?	unknown	no
follow_redirects?	unknown	no
header?	unknown	no
interval?	unknown	no
method?	unknown	no
path?	unknown	no
port?	unknown	no
probe_zone?	unknown	no
retries?	unknown	no
timeout?	unknown	no
type?	unknown	no

fn list_pool_references(pool_id: string)

List Pool References

Argument	Type	Required	Description
pool_id	string	yes	Pool identifier.

fn get_account_load_balancer_monitors_preview_result(preview_id: string)

Preview Result

Argument	Type	Required	Description
preview_id	string	yes

fn list_regions(subdivision_code?: string, subdivision_code_a2?: string, country_code_a2?: string)

List Regions

Argument	Type	Required
subdivision_code?	string	no
subdivision_code_a2?	string	no
country_code_a2?	string	no

fn get_region(region_id: string)

Get Region

Argument	Type	Required	Description
region_id	string	yes

fn get_account_load_balancer_search_search_resources(query?: string, references?: enum, page?: number, per_page?: number)

Search Resources

Argument	Type	Required
query?	string	no
references?	enum	no
page?	number	no
per_page?	number	no

fn list_load_balancer_usage()

List Load Balancer Usage

fn get_account_load_balancers_account_load_balancer_details(load_balancer_id: string)

Account Load Balancer Details

Argument	Type	Required	Description
load_balancer_id	string	yes	Load balancer identifier.

fn update_account_load_balancer(load_balancer_id: string, adaptive_routing?: unknown, country_pools?: unknown, default_pools: unknown, description?: unknown, enabled?: unknown, fallback_pool: unknown, location_strategy?: unknown, name: unknown, networks?: unknown, pop_pools?: unknown, proxied?: unknown, random_steering?: unknown, region_pools?: unknown, rules?: unknown, session_affinity?: unknown, session_affinity_attributes?: unknown, session_affinity_ttl?: unknown, steering_policy?: unknown, ttl?: unknown)

Update Account Load Balancer

Argument	Type	Required	Description
load_balancer_id	string	yes	Load balancer identifier.
adaptive_routing?	unknown	no
country_pools?	unknown	no
default_pools	unknown	yes
description?	unknown	no
enabled?	unknown	no
fallback_pool	unknown	yes
location_strategy?	unknown	no
name	unknown	yes
networks?	unknown	no
pop_pools?	unknown	no
proxied?	unknown	no
random_steering?	unknown	no
region_pools?	unknown	no
rules?	unknown	no
session_affinity?	unknown	no
session_affinity_attributes?	unknown	no
session_affinity_ttl?	unknown	no
steering_policy?	unknown	no
ttl?	unknown	no

fn patch_account_load_balancer(load_balancer_id: string, adaptive_routing?: unknown, country_pools?: unknown, default_pools?: unknown, description?: unknown, enabled?: unknown, fallback_pool?: unknown, location_strategy?: unknown, name?: unknown, networks?: unknown, pop_pools?: unknown, proxied?: unknown, random_steering?: unknown, region_pools?: unknown, rules?: unknown, session_affinity?: unknown, session_affinity_attributes?: unknown, session_affinity_ttl?: unknown, steering_policy?: unknown, ttl?: unknown)

Patch Account Load Balancer

Argument	Type	Required	Description
load_balancer_id	string	yes	Load balancer identifier.
adaptive_routing?	unknown	no
country_pools?	unknown	no
default_pools?	unknown	no
description?	unknown	no
enabled?	unknown	no
fallback_pool?	unknown	no
location_strategy?	unknown	no
name?	unknown	no
networks?	unknown	no
pop_pools?	unknown	no
proxied?	unknown	no
random_steering?	unknown	no
region_pools?	unknown	no
rules?	unknown	no
session_affinity?	unknown	no
session_affinity_attributes?	unknown	no
session_affinity_ttl?	unknown	no
steering_policy?	unknown	no
ttl?	unknown	no

fn delete_account_load_balancer(load_balancer_id: string)

Delete Account Load Balancer

Argument	Type	Required	Description
load_balancer_id	string	yes	Load balancer identifier.

fn list_load_balancers(zone_id: string)

List Load Balancers

Argument	Type	Required	Description
zone_id	string	yes	Cloudflare zone identifier.

fn create_load_balancer(zone_id: string, adaptive_routing?: unknown, country_pools?: unknown, default_pools: unknown, description?: unknown, fallback_pool: unknown, location_strategy?: unknown, name: unknown, networks?: unknown, pop_pools?: unknown, proxied?: unknown, random_steering?: unknown, region_pools?: unknown, rules?: unknown, session_affinity?: unknown, session_affinity_attributes?: unknown, session_affinity_ttl?: unknown, steering_policy?: unknown, ttl?: unknown)

Create Load Balancer

Argument	Type	Required	Description
zone_id	string	yes	Cloudflare zone identifier.
adaptive_routing?	unknown	no
country_pools?	unknown	no
default_pools	unknown	yes
description?	unknown	no
fallback_pool	unknown	yes
location_strategy?	unknown	no
name	unknown	yes
networks?	unknown	no
pop_pools?	unknown	no
proxied?	unknown	no
random_steering?	unknown	no
region_pools?	unknown	no
rules?	unknown	no
session_affinity?	unknown	no
session_affinity_attributes?	unknown	no
session_affinity_ttl?	unknown	no
steering_policy?	unknown	no
ttl?	unknown	no

fn get_load_balancers_load_balancer_details(zone_id: string, load_balancer_id: string)

Load Balancer Details

Argument	Type	Required	Description
zone_id	string	yes	Cloudflare zone identifier.
load_balancer_id	string	yes	Load balancer identifier.

fn update_load_balancer(zone_id: string, load_balancer_id: string, adaptive_routing?: unknown, country_pools?: unknown, default_pools: unknown, description?: unknown, enabled?: unknown, fallback_pool: unknown, location_strategy?: unknown, name: unknown, networks?: unknown, pop_pools?: unknown, proxied?: unknown, random_steering?: unknown, region_pools?: unknown, rules?: unknown, session_affinity?: unknown, session_affinity_attributes?: unknown, session_affinity_ttl?: unknown, steering_policy?: unknown, ttl?: unknown)

Update Load Balancer

Argument	Type	Required	Description
zone_id	string	yes	Cloudflare zone identifier.
load_balancer_id	string	yes	Load balancer identifier.
adaptive_routing?	unknown	no
country_pools?	unknown	no
default_pools	unknown	yes
description?	unknown	no
enabled?	unknown	no
fallback_pool	unknown	yes
location_strategy?	unknown	no
name	unknown	yes
networks?	unknown	no
pop_pools?	unknown	no
proxied?	unknown	no
random_steering?	unknown	no
region_pools?	unknown	no
rules?	unknown	no
session_affinity?	unknown	no
session_affinity_attributes?	unknown	no
session_affinity_ttl?	unknown	no
steering_policy?	unknown	no
ttl?	unknown	no

fn patch_load_balancer(zone_id: string, load_balancer_id: string, adaptive_routing?: unknown, country_pools?: unknown, default_pools?: unknown, description?: unknown, enabled?: unknown, fallback_pool?: unknown, location_strategy?: unknown, name?: unknown, pop_pools?: unknown, proxied?: unknown, random_steering?: unknown, region_pools?: unknown, rules?: unknown, session_affinity?: unknown, session_affinity_attributes?: unknown, session_affinity_ttl?: unknown, steering_policy?: unknown, ttl?: unknown)

Patch Load Balancer

Argument	Type	Required	Description
zone_id	string	yes	Cloudflare zone identifier.
load_balancer_id	string	yes	Load balancer identifier.
adaptive_routing?	unknown	no
country_pools?	unknown	no
default_pools?	unknown	no
description?	unknown	no
enabled?	unknown	no
fallback_pool?	unknown	no
location_strategy?	unknown	no
name?	unknown	no
pop_pools?	unknown	no
proxied?	unknown	no
random_steering?	unknown	no
region_pools?	unknown	no
rules?	unknown	no
session_affinity?	unknown	no
session_affinity_attributes?	unknown	no
session_affinity_ttl?	unknown	no
steering_policy?	unknown	no
ttl?	unknown	no

fn delete_load_balancer(zone_id: string, load_balancer_id: string)

Delete Load Balancer

Argument	Type	Required	Description
zone_id	string	yes	Cloudflare zone identifier.
load_balancer_id	string	yes	Load balancer identifier.

04Previous Versions3

2026.08.21.1Aug 21, 2026

2026.08.21.1

Changed: Added .describe() and .min(1) to the identifier arguments used across most methods — zone_id, load_balancer_id, pool_id, monitor_id, and monitor_group_id now document their purpose and reject empty strings, which the Cloudflare API never accepts for these path parameters. No behavioral changes.

2026.07.27.1

Fixed: Regenerated from scripts/cloudflare-codegen after two generator bugs were repaired (webframp/swamp-extensions#284).

Methods referencing an undeclared path parameter did not compile. The generator derived a method's arguments schema and execute signature from the OpenAPI parameters list, but built the request URL from the path template. Where the Cloudflare spec omits a declaration for a {placeholder} — which it does in several places — the result was a method with arguments: z.object({}) and an unused _args parameter whose body still interpolated args.<name>. Those methods failed type checking and were uncallable even if they had compiled, because the argument was never declared. Path-template placeholders are now unioned into the declared parameters, so the schema, the signature, and the body agree.
Generated tests could request a URL the mock server did not serve. Test arguments merged the request-body fixture over the path-parameter values, so a body property sharing a name with a path parameter (commonly id) substituted its own example value into the URL. The request then missed the mock and failed with Cloudflare API error: Not found. Path parameters now take precedence, matching what the generated model already does by excluding path-parameter names from the request body.

Upgrade note: No API surface change and no method was added or removed. If this extension type-checked and tested cleanly before, its behavior is unchanged and only the version moved. Extensions that previously failed deno check or deno task test now pass.

2026.07.27.1Jul 27, 2026

2026.07.27.1

Fixed: Regenerated from scripts/cloudflare-codegen after two generator bugs were repaired (webframp/swamp-extensions#284).

Methods referencing an undeclared path parameter did not compile. The generator derived a method's arguments schema and execute signature from the OpenAPI parameters list, but built the request URL from the path template. Where the Cloudflare spec omits a declaration for a {placeholder} — which it does in several places — the result was a method with arguments: z.object({}) and an unused _args parameter whose body still interpolated args.<name>. Those methods failed type checking and were uncallable even if they had compiled, because the argument was never declared. Path-template placeholders are now unioned into the declared parameters, so the schema, the signature, and the body agree.
Generated tests could request a URL the mock server did not serve. Test arguments merged the request-body fixture over the path-parameter values, so a body property sharing a name with a path parameter (commonly id) substituted its own example value into the URL. The request then missed the mock and failed with Cloudflare API error: Not found. Path parameters now take precedence, matching what the generated model already does by excluding path-parameter names from the request body.