Skip to main content

Cloudflare/gateway

@webframp/cloudflare/gatewayv2026.08.21.2· 1d agoMODELS
01README

Cloudflare Gateway — DNS/HTTP policies, locations, proxy endpoints

02Release Notes

2026.08.21.2

Changed: Error messages for API failures and invalid input are now specific instead of generic.

  • Every method that calls the Cloudflare API now wraps failures with the operation attempted and the account/identifier involved (e.g. certificate_id, list_id, location_id, pacfile_id, proxy_endpoint_id, rule_id), instead of surfacing the raw SDK error with no context.
  • Methods that take a certificate_id, list_id, location_id, operation_id, pacfile_id, proxy_endpoint_id, or rule_id now reject an empty value up front with a clear validation error, instead of sending a malformed request to the Cloudflare API.

Upgrade note: No behavioral change for valid requests. Callers passing an empty identifier will now get an immediate, descriptive validation error instead of a Cloudflare API failure.

03Models1
cloudflare/gateway.tsv2026.08.21.2

Global Arguments

ArgumentTypeDescription
apiTokenstringCloudflare API token
accountIdstringCloudflare account ID
fn get_zero_trust_account_information()
Get Zero Trust account information
fn create_zero_trust_account()
Create Zero Trust account
fn list_application_and_application_type_mappings()
List application and application type mappings
fn list()
List applications review statuses
fn update(approved_apps: unknown, in_review_apps: unknown, unapproved_apps: unknown)
Update applications review statuses
ArgumentTypeDescription
approved_appsunknown
in_review_appsunknown
unapproved_appsunknown
fn get_audit_ssh_settings()
Get Zero Trust SSH settings
fn update_audit_ssh_settings(public_key: unknown)
Update Zero Trust SSH settings
ArgumentTypeDescription
public_keyunknown
fn zero_trust_rotate_ssh_account_seed()
Rotate Zero Trust SSH account seed
fn list_categories()
List categories
fn list_zero_trust_certificates()
List Zero Trust certificates
fn create_zero_trust_certificate(validity_period_days?: number)
Create Zero Trust certificate
ArgumentTypeDescription
validity_period_days?numberSets the certificate validity period in days (range: 1-10,950 days / ~30 year...
fn get_zero_trust_certificates_zero_trust_certificate_details(certificate_id: string)
Get Zero Trust certificate details
ArgumentTypeDescription
certificate_idstring
fn delete_zero_trust_certificate(certificate_id: string)
Delete Zero Trust certificate
ArgumentTypeDescription
certificate_idstring
fn zero_trust_certificates_activate_zero_trust_certificate(certificate_id: string)
Activate a Zero Trust certificate
ArgumentTypeDescription
certificate_idstring
fn zero_trust_certificates_deactivate_zero_trust_certificate(certificate_id: string)
Deactivate a Zero Trust certificate
ArgumentTypeDescription
certificate_idstring
fn get_zero_trust_account_configuration()
Get Zero Trust account configuration
fn update_zero_trust_account_configuration(settings?: object)
Update Zero Trust account configuration
ArgumentTypeDescription
settings?objectSpecify account settings.
fn patch_zero_trust_account_configuration(settings?: object)
Patch Zero Trust account configuration
ArgumentTypeDescription
settings?objectSpecify account settings.
fn list_dns_destination_ips()
List Zero Trust Gateway DNS destination IPv4 address pairs
fn get_egress_cidr_pairs()
Get gateway egress CIDRs pairs assigned to this account
fn list_zero_trust_lists(type?: string)
List Zero Trust lists
ArgumentTypeDescription
type?string
fn list_details(list_id: string)
Get Zero Trust list details
ArgumentTypeDescription
list_idstring
fn list_items(list_id: string)
Get Zero Trust list items
ArgumentTypeDescription
list_idstring
fn list_zero_trust_gateway_locations()
List Zero Trust Gateway locations
fn create_zero_trust_gateway_location(client_default?: unknown, dns_destination_ips_id?: unknown, ecs_support?: unknown, endpoints?: unknown, max_ttl?: unknown, name: unknown, networks?: unknown)
Create a Zero Trust Gateway location
ArgumentTypeDescription
client_default?unknown
dns_destination_ips_id?unknown
ecs_support?unknown
endpoints?unknown
max_ttl?unknown
nameunknown
networks?unknown
fn get_zero_trust_gateway_locations_zero_trust_gateway_location_details(location_id: string)
Get Zero Trust Gateway location details
ArgumentTypeDescription
location_idstring
fn update_zero_trust_gateway_location(location_id: string, client_default?: unknown, dns_destination_ips_id?: unknown, ecs_support?: unknown, endpoints?: unknown, max_ttl?: unknown, name: unknown, networks?: unknown)
Update a Zero Trust Gateway location
ArgumentTypeDescription
location_idstring
client_default?unknown
dns_destination_ips_id?unknown
ecs_support?unknown
endpoints?unknown
max_ttl?unknown
nameunknown
networks?unknown
fn delete_zero_trust_gateway_location(location_id: string)
Delete a Zero Trust Gateway location
ArgumentTypeDescription
location_idstring
fn get_logging_settings_for_the_zero_trust_account()
Get logging settings for the Zero Trust account
fn update_logging_settings_for_the_zero_trust_account(redact_pii?: boolean, settings_by_rule_type?: object)
Update Zero Trust account logging settings
ArgumentTypeDescription
redact_pii?booleanIndicate whether to redact personally identifiable information from activity ...
settings_by_rule_type?objectConfigure logging settings for each rule type.
fn list_zero_trust_gateway_operations()
List Zero Trust Gateway operations
fn get_zero_trust_gateway_operations_zero_trust_gateway_operation_details(operation_id: string)
Zero Trust Gateway operation details
ArgumentTypeDescription
operation_idstring
fn create_pacfile(contents: unknown, description?: unknown, name: unknown, slug?: string)
Create a PAC file
ArgumentTypeDescription
contentsunknown
description?unknown
nameunknown
slug?stringURL-friendly version of the PAC file name. If not provided, it will be auto-g...
fn get_zero_trust_gateway_pacfiles_details(pacfile_id: string)
Get a PAC file
ArgumentTypeDescription
pacfile_idstring
fn delete(pacfile_id: string)
Delete a PAC file
ArgumentTypeDescription
pacfile_idstring
fn list_proxy_endpoints()
List proxy endpoints
fn create_proxy_endpoint(body?: union)
Create a proxy endpoint
ArgumentTypeDescription
body?union
fn get_zero_trust_gateway_proxy_endpoints_proxy_endpoint_details(proxy_endpoint_id: string)
Get a proxy endpoint
ArgumentTypeDescription
proxy_endpoint_idstring
fn update_proxy_endpoint(proxy_endpoint_id: string, ips?: unknown, name?: unknown)
Update a proxy endpoint
ArgumentTypeDescription
proxy_endpoint_idstring
ips?unknown
name?unknown
fn delete_proxy_endpoint(proxy_endpoint_id: string)
Delete a proxy endpoint
ArgumentTypeDescription
proxy_endpoint_idstring
fn list_zero_trust_gateway_rules()
List Zero Trust Gateway rules
fn create_zero_trust_gateway_rule(action: unknown, description?: unknown, device_posture?: unknown, enabled?: unknown, expiration?: unknown, filters?: unknown, identity?: unknown, name: unknown, precedence?: unknown, rule_settings?: unknown, schedule?: unknown, traffic?: unknown)
Create a Zero Trust Gateway rule
ArgumentTypeDescription
actionunknown
description?unknown
device_posture?unknown
enabled?unknown
expiration?unknown
filters?unknown
identity?unknown
nameunknown
precedence?unknown
rule_settings?unknown
schedule?unknown
traffic?unknown
fn patch_multiple_zero_trust_gateway_rules(items?: array)
Patch multiple Zero Trust Gateway rules
ArgumentTypeDescription
items?array
fn list_zero_trust_gateway_rules_tenant()
List Zero Trust Gateway rules inherited from the parent account
fn get_zero_trust_gateway_rules_zero_trust_gateway_rule_details(rule_id: string)
Get Zero Trust Gateway rule details.
ArgumentTypeDescription
rule_idstring
fn update_zero_trust_gateway_rule(rule_id: string, action: unknown, description?: unknown, device_posture?: unknown, enabled?: unknown, expiration?: unknown, filters?: unknown, identity?: unknown, name: unknown, precedence?: unknown, rule_settings?: unknown, schedule?: unknown, traffic?: unknown)
Update a Zero Trust Gateway rule
ArgumentTypeDescription
rule_idstring
actionunknown
description?unknown
device_posture?unknown
enabled?unknown
expiration?unknown
filters?unknown
identity?unknown
nameunknown
precedence?unknown
rule_settings?unknown
schedule?unknown
traffic?unknown
fn patch_zero_trust_gateway_rule(rule_id: string, description?: unknown, enabled?: unknown, name?: unknown, precedence?: unknown)
Patch a Zero Trust Gateway rule
ArgumentTypeDescription
rule_idstring
description?unknown
enabled?unknown
name?unknown
precedence?unknown
fn delete_zero_trust_gateway_rule(rule_id: string)
Delete a Zero Trust Gateway rule
ArgumentTypeDescription
rule_idstring
fn zero_trust_gateway_rules_reset_expiration_zero_trust_gateway_rule(rule_id: string)
Reset the expiration of a Zero Trust Gateway Rule
ArgumentTypeDescription
rule_idstring
04Previous Versions3
2026.08.21.1

2026.08.21.1

Fixed: Regenerated with three cloudflare-codegen fixes: (1) discriminated-union request bodies with a sibling top-level discriminator property (e.g. gateway proxy_endpoints kind) now correctly build the body from the full oneOf variant instead of silently dropping it to undefined; (2) DELETE methods with a request body (e.g. r2 delete_objects bulk-delete-by-list) now send that body instead of ignoring it; (3) oneOf/anyOf request body variants that are $ref (e.g. r2 sippy config) are now resolved to their real schema instead of collapsing to z.unknown(). Same generator fix as workers-scripts in #352, now caught up for these 7 services.

Changed: list_from_csv was removed — it is no longer present in the upstream Cloudflare API spec this extension is generated from.

Upgrade note: create_proxy_endpoint's arguments changed shape. It previously took { kind } directly and silently discarded any name you passed. It now takes { body: { kind, name } }, with name required inside body. Calls using the old { kind } shape will fail schema validation and must be updated to { body: { kind, name } }.

Modified 1 models

2026.07.27.1

2026.07.27.1

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

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

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

2026.07.19.1

Added: Initial code-generated release of @webframp/cloudflare/gateway with 50 methods covering the Cloudflare gateway API surface.

05Stats
A
100 / 100
Downloads
0
Archive size
24.4 KB
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License declared1/1earned
  • Verified public repository2/2earned
06Platforms
07Labels