Cloudflare/workers Scripts

@webframp/cloudflare/workers-scriptsv2026.08.28.2· 13d agoMODELS

01README

Cloudflare Workers Scripts — upload, deploy, bindings, routes, cron triggers

02Release Notes

2026.08.28.2

Hardened codegen: instance names sanitized against path traversal; 429 rate-limit retry with Retry-After; string schema patterns emit regex validation; output schemas passthrough unknown fields; apiToken now optional and vault-wireable with CLOUDFLARE_API_TOKEN env fallback.

03Models1

@webframp/cloudflare/workers-scriptsv2026.08.28.2cloudflare/workers_scripts.ts

Global Arguments

Argument	Type	Required	Description
apiToken?	string	no	Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
accountId	string	yes	Cloudflare account ID

fn list_workers(tags?: string)

List Workers

Argument	Type	Required	Description
tags?	string	no	Filter scripts by tags. Format: comma-separated list of tag:allowed pairs where allowed is 'yes' or 'no'.

fn list_worker_script_search_workers(name?: string, id?: string, order_by?: enum, page?: number, per_page?: number)

Search Workers

Argument	Type	Required	Description
name?	string	no
id?	string	no
order_by?	enum	no
page?	number	no	Current page.
per_page?	number	no	Items per page.

fn delete_worker(script_name: string, force?: boolean)

Delete Worker

Argument	Type	Required	Description
script_name	string	yes
force?	boolean	no	If set to true, delete will not be stopped by associated service binding, durable object, or other binding. Any of these associated bindings/durable objects will be deleted along with the script.

fn create_assets_upload_session(script_name: string, manifest: record)

Create Assets Upload Session

Argument	Type	Required	Description
script_name	string	yes
manifest	record	yes	A manifest ([path]: {hash, size}) map of files to upload. As an example, `/bl...

fn list_deployments(script_name: string)

List Deployments

Argument	Type	Required	Description
script_name	string	yes

fn create_deployment(script_name: string, force?: boolean, annotations?: object, author_email?: string, created_on: string, source: string, strategy: enum, versions: array)

Create Deployment

Argument	Type	Required	Description
script_name	string	yes
force?	boolean	no	If set to true, the deployment will be created even if normally blocked by something such rolling back to an older version when a secret has changed.
annotations?	object	no
author_email?	string	no
created_on	string	yes
source	string	yes
strategy	enum	yes
versions	array	yes

fn get_deployment(script_name: string, deployment_id: string)

Get Deployment

Argument	Type	Required	Description
script_name	string	yes
deployment_id	string	yes

fn delete_deployment(script_name: string, deployment_id: string)

Delete Deployment

Argument	Type	Required	Description
script_name	string	yes
deployment_id	string	yes

fn get_cron_triggers(script_name: string)

Get Cron Triggers

Argument	Type	Required	Description
script_name	string	yes

fn update_cron_triggers(script_name: string, items: array)

Update Cron Triggers

Argument	Type	Required	Description
script_name	string	yes
items	array	yes

fn get_settings(script_name: string)

Get Script Settings

Argument	Type	Required	Description
script_name	string	yes

fn patch_settings(script_name: string, logpush?: unknown, observability?: unknown, tags?: unknown, tail_consumers?: array)

Patch Script Settings

Argument	Type	Required	Description
script_name	string	yes
logpush?	unknown	no
observability?	unknown	no
tags?	unknown	no
tail_consumers?	array	no	List of Workers that will consume logs from the attached Worker.

fn list_script_secrets(script_name: string)

List script secrets

Argument	Type	Required	Description
script_name	string	yes

fn put_script_secret(script_name: string, body: union)

Add script secret

Argument	Type	Required	Description
script_name	string	yes
body	union	yes	A secret value accessible through a binding.

fn patch_script_secrets_bulk(script_name: string, secrets?: record, version_tags?: record)

Patch multiple script secrets

Argument	Type	Required	Description
script_name	string	yes
secrets?	record	no	Map of secret names to secret values: - Set to a secret object to create or u...
version_tags?	record	no	Optional version tags to apply to the new script version.

fn get_script_secret(script_name: string, secret_name: string, url_encoded?: string)

Get secret binding

Argument	Type	Required
script_name	string	yes
secret_name	string	yes
url_encoded?	string	no

fn delete_script_secret(script_name: string, secret_name: string, url_encoded?: string)

Delete script secret

Argument	Type	Required
script_name	string	yes
secret_name	string	yes
url_encoded?	string	no

fn get_subdomain(script_name: string)

Get Worker subdomain

Argument	Type	Required	Description
script_name	string	yes

fn create_worker_script_post_subdomain(script_name: string, enabled: boolean, previews_enabled?: boolean)

Post Worker subdomain

Argument	Type	Required	Description
script_name	string	yes
enabled	boolean	yes	Whether the Worker should be available on the workers.dev subdomain.
previews_enabled?	boolean	no	Whether the Worker's Preview URLs should be available on the workers.dev subd...

fn delete_subdomain(script_name: string)

Delete Worker subdomain

Argument	Type	Required	Description
script_name	string	yes

fn list_tails(script_name: string)

List Tails

Argument	Type	Required	Description
script_name	string	yes

fn worker_tail_logs_start_tail(script_name: string)

Start Tail

Argument	Type	Required	Description
script_name	string	yes

fn delete_tail(script_name: string, id: string)

Delete Tail

Argument	Type	Required	Description
script_name	string	yes
id	string	yes

fn get_worker_script_fetch_usage_model(script_name: string)

Fetch Usage Model

Argument	Type	Required	Description
script_name	string	yes

fn update_usage_model(script_name: string, usage_model?: unknown, user_limits?: unknown)

Update Usage Model

Argument	Type	Required
script_name	string	yes
usage_model?	unknown	no
user_limits?	unknown	no

fn list_versions(script_name: string, deployable?: boolean, page?: number, per_page?: number)

List Versions

Argument	Type	Required	Description
script_name	string	yes
deployable?	boolean	no	Only return versions that can be used in a deployment. Ignores pagination.
page?	number	no	Current page.
per_page?	number	no	Items per-page.

fn get_version_detail(script_name: string, version_id: string)

Get Version Detail

Argument	Type	Required	Description
script_name	string	yes
version_id	string	yes

Resources

workers(infinite)— List Workers

worker_script_search_workers(infinite)— Search Workers

assets_upload_session(infinite)— Create Assets Upload Session

list_deployments(infinite)— List Deployments

deployment(infinite)— Create Deployment

cron_triggers(infinite)— Get Cron Triggers

settings(infinite)— Get Script Settings

patch_settings(infinite)— Patch Script Settings

script_secrets(infinite)— List script secrets

put_script_secret(infinite)— Add script secret

patch_script_secrets_bulk(infinite)— Patch multiple script secrets

script_secret(infinite)— Get secret binding

subdomain(infinite)— Get Worker subdomain

worker_script_post_subdomain(infinite)— Post Worker subdomain

list_tails(infinite)— List Tails

worker_tail_logs_start_tail(infinite)— Start Tail

worker_script_fetch_usage_model(infinite)— Fetch Usage Model

usage_model(infinite)— Update Usage Model

list_versions(infinite)— List Versions

version_detail(infinite)— Get Version Detail

04Previous Versions8

2026.08.28.1Aug 28, 2026

2026.08.28.1

Changed: Normalized the extension license to Apache-2.0 and corrected the copyright holder to "Sean Escriva". Extensions that previously shipped an MIT LICENSE.md are now Apache-2.0, consistent with the repository root and every other extension. No code or behavioral changes.

Upgrade note: License text only. No API, schema, or runtime behavior changed.

2026.08.26.2

Fixed: Restored inline npm:zod@4.4.3 import specifiers so the registry quality scorer can resolve dependencies and score the extension. An earlier release used a bare "zod" import-map specifier, which published but scored as unscored.

Changed: Retained explicit compilerOptions.strict in deno.json. No behavioral or schema changes.

2026.08.26.2Aug 27, 2026

2026.08.26.2

Changed: Retained explicit compilerOptions.strict in deno.json. No behavioral or schema changes.

2026.08.24.1Aug 24, 2026

2026.08.24.1

Added: Output metadata attributes for observability.

durationMs: Method execution duration in milliseconds.
collectedBy: Extension name that produced the data.
fetchedAt: ISO 8601 timestamp when data was fetched (added to resources that previously lacked it).

2026.08.21.1Aug 22, 2026

2026.08.21.1

Changed: Errors and validation now say what went wrong and where.

Cloudflare API failures (HTTP errors and success: false API responses) now name the HTTP method and path that was attempted, in addition to the original status/message. Previously the error read only Cloudflare API error: <message>, with no indication of which endpoint the method call was hitting — now it reads Cloudflare API request failed: GET /accounts/<account>/workers/scripts/<name>: <message>. This applies to every method on this model, since they all share the same request helper.
script_name and deployment_id are now validated as non-empty before any request is made. Passing an empty string previously sent a request to a malformed URL and produced a confusing 404 from Cloudflare; each now fails fast with a <field> must not be empty message.

Upgrade note: No method was added, removed, or renamed. Existing callers that always pass non-empty identifiers see no behavioral change beyond clearer error text.

2026.08.13.2Aug 13, 2026

2026.08.13.2

Removed: update_worker_script_upload_worker_module and worker_versions_upload_version methods. These endpoints require multipart/form-data uploads that cfApi's JSON helper cannot serve. Use @webframp/cloudflare/worker's deploy method for script uploads.

Fixed: Codegen now resolves requestBody $ref before content-type filtering.

Modified 1 models

2026.08.13.1Aug 13, 2026

2026.08.13.1

Fixed: update_cron_triggers and put_script_secret now accept proper request body arguments instead of always sending an empty payload. update_cron_triggers accepts an items array of cron schedule objects; put_script_secret accepts a body argument with the secret definition.

Removed: put_content and put_script_content methods removed — these endpoints require multipart/form-data uploads that the JSON-only API helper cannot support. Use wrangler for script content deployment.

Changed: Extension regenerated with codegen fixes for bare-array and oneOf/discriminated-union request body handling.

Modified 1 models

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.

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.1Jul 19, 2026

2026.07.19.1

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

05Stats

100 / 100

Downloads

Archive size

22.9 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

Repository

https://github.com/webframp/swamp-extensions

06Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

07Labels

#cloudflare #workers #serverless #scripts