Workers

ModelsExpand Collapse

MigrationStep { deleted_classes, new_classes, new_sqlite_classes, 2 more }

deleted_classes?: Array<string>

A list of classes to delete Durable Object namespaces from.

new_classes?: Array<string>

A list of classes to create Durable Object namespaces from.

new_sqlite_classes?: Array<string>

A list of classes to create Durable Object namespaces with SQLite from.

renamed_classes?: Array<RenamedClass>

A list of classes with Durable Object namespaces that were renamed.

from?: string

to?: string

transferred_classes?: Array<TransferredClass>

A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker.

from?: string

from_script?: string

to?: string

SingleStepMigration { deleted_classes, new_classes, new_sqlite_classes, 4 more }

A single set of migrations to apply.

deleted_classes?: Array<string>

A list of classes to delete Durable Object namespaces from.

new_classes?: Array<string>

A list of classes to create Durable Object namespaces from.

new_sqlite_classes?: Array<string>

A list of classes to create Durable Object namespaces with SQLite from.

new_tag?: string

Tag to set as the latest migration tag.

old_tag?: string

Tag used to verify against the latest migration tag for this Worker. If they don’t match, the upload is rejected.

renamed_classes?: Array<RenamedClass>

A list of classes with Durable Object namespaces that were renamed.

from?: string

to?: string

transferred_classes?: Array<TransferredClass>

A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker.

from?: string

from_script?: string

to?: string

WorkerMetadata { body_part, main_module }

JSON-encoded metadata about the uploaded parts and Worker configuration.

body_part?: string

Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the fetch event). Indicates a service worker syntax Worker.

main_module?: string

Name of the part in the multipart request that contains the main module (e.g. the file exporting a fetch handler). Indicates a module syntax Worker.

WorkersBeta

WorkersBetaWorkers

List Workers

client.workers.beta.workers.list(, ?): V4PagePaginationArray<Worker { id, created_on, logpush, 9 more } >

GET/accounts/{account_id}/workers/workers

Get Worker

client.workers.beta.workers.get(, , ?): Worker { id, created_on, logpush, 9 more }

GET/accounts/{account_id}/workers/workers/{worker_id}

Create Worker

client.workers.beta.workers.create(, ?): Worker { id, created_on, logpush, 9 more }

POST/accounts/{account_id}/workers/workers

Update Worker

client.workers.beta.workers.update(, , ?): Worker { id, created_on, logpush, 9 more }

PUT/accounts/{account_id}/workers/workers/{worker_id}

Edit Worker

client.workers.beta.workers.edit(, , ?): Worker { id, created_on, logpush, 9 more }

PATCH/accounts/{account_id}/workers/workers/{worker_id}

Delete Worker

client.workers.beta.workers.delete(, , ?): WorkerDeleteResponse { errors, messages, success }

DELETE/accounts/{account_id}/workers/workers/{worker_id}

ModelsExpand Collapse

Worker { id, created_on, logpush, 9 more }

id: string

Immutable ID of the Worker.

created_on: string

When the Worker was created.

formatdate-time

logpush: boolean

Whether logpush is enabled for the Worker.

Name of the Worker.

observability: Observability { enabled, head_sampling_rate, issues, 3 more }

Observability settings for the Worker.

enabled?: boolean

Whether observability is enabled for the Worker.

head_sampling_rate?: number

The sampling rate for observability. From 0 to 1 (1 = 100%, 0.1 = 10%).

issues?: Issues | null

Real-time Issues settings for the Worker.

enabled?: boolean

Whether real-time Issues are enabled for the Worker.

logs?: Logs { destinations, enabled, head_sampling_rate, 2 more }

Log settings for the Worker.

destinations?: Array<string>

A list of destinations where logs will be exported to.

enabled?: boolean

Whether logs are enabled for the Worker.

head_sampling_rate?: number

The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%).

invocation_logs?: boolean

Whether invocation logs are enabled for the Worker.

persist?: boolean

Whether log persistence is enabled for the Worker.

redact_query_string?: boolean

Whether query strings are removed from request URLs in logs and traces.

traces?: Traces { destinations, enabled, head_sampling_rate, 2 more }

Trace settings for the Worker.

destinations?: Array<string>

A list of destinations where traces will be exported to.

enabled?: boolean

Whether traces are enabled for the Worker.

head_sampling_rate?: number

The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%).

persist?: boolean

Whether trace persistence is enabled for the Worker.

propagation_policy?: "authenticated" | "accept" | null

Controls how inbound trace context (traceparent/tracestate) headers on incoming requests are handled. “authenticated” honors inbound trace context only when accompanied by a valid trace auth token. “accept” unconditionally accepts inbound trace context. Requires the trace propagation feature to be enabled. Returns null when the trace propagation feature is not enabled for the account.

One of the following:

"authenticated"

"accept"

references: References { dispatch_namespace_outbounds, domains, durable_objects, 2 more }

Other resources that reference the Worker and depend on it existing.

dispatch_namespace_outbounds: Array<DispatchNamespaceOutbound>

Other Workers that reference the Worker as an outbound for a dispatch namespace.

namespace_id: string

ID of the dispatch namespace.

namespace_name: string

Name of the dispatch namespace.

worker_id: string

ID of the Worker using the dispatch namespace.

worker_name: string

Name of the Worker using the dispatch namespace.

domains: Array<Domain>

Custom domains connected to the Worker.

id: string

ID of the custom domain.

certificate_id: string

ID of the TLS certificate issued for the custom domain.

hostname: string

Full hostname of the custom domain, including the zone name.

zone_id: string

ID of the zone.

zone_name: string

Name of the zone.

durable_objects: Array<DurableObject>

Other Workers that reference Durable Object classes implemented by the Worker.

namespace_id: string

ID of the Durable Object namespace being used.

namespace_name: string

Name of the Durable Object namespace being used.

worker_id: string

ID of the Worker using the Durable Object implementation.

worker_name: string

Name of the Worker using the Durable Object implementation.

queues: Array<Queue>

Queues that send messages to the Worker.

queue_consumer_id: string

ID of the queue consumer configuration.

queue_id: string

ID of the queue.

queue_name: string

Name of the queue.

workers: Array<Worker>

Other Workers that reference the Worker using service bindings.

id: string

ID of the referencing Worker.

Name of the referencing Worker.

subdomain: Subdomain { enabled, preview_url_suffix, previews_enabled, url }

Subdomain settings for the Worker.

enabled?: boolean

Whether the *.workers.dev subdomain is enabled for the Worker.

preview_url_suffix?: string

Prepend a version or preview prefix to this host suffix to form the *.workers.dev preview URL the Worker would serve on once previews are enabled, e.g. https://<prefix>-my-worker.my-subdomain.workers.dev. Present whenever the account owns a workers.dev subdomain, regardless of whether previews_enabled is true, so presence does not imply preview URLs are currently live. Absent only when the account owns no workers.dev subdomain.

previews_enabled?: boolean

Whether preview URLs are enabled for the Worker.

url?: string

The address the Worker would serve on once its *.workers.dev subdomain is enabled. Present whenever the account owns a workers.dev subdomain, regardless of whether enabled is true, so presence does not imply the Worker is currently live at this URL. Absent only when the account owns no workers.dev subdomain.

formaturi

tags: Array<string>

Tags associated with the Worker.

tail_consumers: Array<TailConsumer>

Other Workers that should consume logs from the Worker.

Name of the consumer Worker.

updated_on: string

When the Worker was most recently updated.

formatdate-time

deployed_on?: string | null

When the Worker’s most recent deployment was created. null if the Worker has never been deployed.

formatdate-time

previews_base_config?: PreviewsBaseConfig { cache_options, env, limits, 4 more }

Template configuration used when creating new Previews for this Worker.

cache_options?: CacheOptions { enabled, cross_version_cache }

Cache options used when creating new Previews.

enabled: boolean

Whether caching is enabled for this Worker.

cross_version_cache?: boolean

Whether cached responses are shared across Worker version uploads. This is independent of enabled. It can stay true while caching is off, so the preference survives turning caching off and back on.

env?: Record<string, Env>

Bindings used when creating new Previews, keyed by binding name.

type: string

The kind of resource that the binding provides.

limits?: Limits { cpu_ms, subrequests }

Resource limits enforced at runtime for newly created Previews.

cpu_ms?: number

The amount of CPU time this Worker can use in milliseconds.

subrequests?: number

The number of subrequests this Worker can make per request.

logpush?: boolean

Whether logpush is enabled when creating new Previews.

observability?: Observability { enabled, head_sampling_rate, issues, 3 more }

Observability settings used when creating new Previews.

enabled?: boolean

Whether observability is enabled for the Worker.

head_sampling_rate?: number

The sampling rate for observability. From 0 to 1 (1 = 100%, 0.1 = 10%).

issues?: Issues | null

Real-time Issues settings for the Worker.

enabled?: boolean

Whether real-time Issues are enabled for the Worker.

logs?: Logs { destinations, enabled, head_sampling_rate, 2 more }

Log settings for the Worker.

destinations?: Array<string>

A list of destinations where logs will be exported to.

enabled?: boolean

Whether logs are enabled for the Worker.

head_sampling_rate?: number

The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%).

invocation_logs?: boolean

Whether invocation logs are enabled for the Worker.

persist?: boolean

Whether log persistence is enabled for the Worker.

redact_query_string?: boolean

Whether query strings are removed from request URLs in logs and traces.

traces?: Traces { destinations, enabled, head_sampling_rate, 2 more }

Trace settings for the Worker.

destinations?: Array<string>

A list of destinations where traces will be exported to.

enabled?: boolean

Whether traces are enabled for the Worker.

head_sampling_rate?: number

The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%).

persist?: boolean

Whether trace persistence is enabled for the Worker.

propagation_policy?: "authenticated" | "accept" | null

One of the following:

"authenticated"

"accept"

placement?: Mode { mode } | Region { region } | Hostname { hostname } | 5 more

Placement configuration used when creating new Previews.

One of the following:

Mode { mode }

mode: "smart"

Enables Smart Placement.

Region { region }

region: string

Cloud region for targeted placement in format ‘provider:region’.

Hostname { hostname }

hostname: string

HTTP hostname for targeted placement.

Host { host }

host: string

TCP host and port for targeted placement.

UnionMember4 { mode, region }

mode: "targeted"

Targeted placement mode.

region: string

Cloud region for targeted placement in format ‘provider:region’.

UnionMember5 { hostname, mode }

hostname: string

HTTP hostname for targeted placement.

mode: "targeted"

Targeted placement mode.

UnionMember6 { host, mode }

host: string

TCP host and port for targeted placement.

mode: "targeted"

Targeted placement mode.

UnionMember7 { mode, target }

mode: "targeted"

Targeted placement mode.

target: Array<Region { region } | Hostname { hostname } | Host { host } >

Array of placement targets (currently limited to single target).

One of the following:

Region { region }

region: string

Cloud region in format ‘provider:region’.

Hostname { hostname }

hostname: string

HTTP hostname for targeted placement.

Host { host }

host: string

TCP host:port for targeted placement.

tail_consumers?: Array<TailConsumer>

Other Workers that should consume logs from newly created Previews.

Name of the consumer Worker.

WorkerDeleteResponse { errors, messages, success }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

WorkersBetaWorkersVersions

List Worker Versions

client.workers.beta.workers.versions.list(, , ?): V4PagePaginationArray<Version { id, created_on, number, 22 more } >

GET/accounts/{account_id}/workers/workers/{worker_id}/versions

Get Worker Version

client.workers.beta.workers.versions.get(, , ?): Version { id, created_on, number, 22 more }

GET/accounts/{account_id}/workers/workers/{worker_id}/versions/{version_id}

Create Worker Version

client.workers.beta.workers.versions.create(, , ?): Version { id, created_on, number, 22 more }

POST/accounts/{account_id}/workers/workers/{worker_id}/versions

Delete Worker Version

client.workers.beta.workers.versions.delete(, , ?): VersionDeleteResponse { errors, messages, success }

DELETE/accounts/{account_id}/workers/workers/{worker_id}/versions/{version_id}

ModelsExpand Collapse

Version { id, created_on, number, 22 more }

id: string

Version identifier.

formatuuid

created_on: string

When the version was created.

formatdate-time

number: number

The integer version number, starting from one.

urls: Array<string>

All routable URLs that always point to this version. Does not include alias URLs, since aliases can be updated to point to a different version.

annotations?: Annotations { workers/message, workers/tag, workers/triggered_by }

Metadata about the version.

"workers/message"?: string

Human-readable message about the version. Truncated to 1000 bytes if longer.

maxLength1000

"workers/tag"?: string

User-provided identifier for the version. Maximum 100 bytes.

maxLength100

"workers/triggered_by"?: string

Operation that triggered the creation of the version.

assets?: Assets { config, jwt }

Configuration for assets within a Worker.

_headers and _redirects files should be included as modules named _headers and _redirects with content type text/plain.

config?: Config { base_path, html_handling, not_found_handling, run_worker_first }

Configuration for assets within a Worker.

base_path?: string | null

The public URL path prefix under which assets are served. A null request value resets it to /; responses represent the root as /. All versions in a gradual deployment must use the same canonical value. To change it, first deploy the version containing the change at 100%.

html_handling?: "auto-trailing-slash" | "force-trailing-slash" | "drop-trailing-slash" | "none"

Determines the redirects and rewrites of requests for HTML content.

One of the following:

"auto-trailing-slash"

"force-trailing-slash"

"drop-trailing-slash"

"none"

not_found_handling?: "none" | "404-page" | "single-page-application"

Determines the response when a request does not match a static asset, and there is no Worker script.

One of the following:

"none"

"404-page"

"single-page-application"

run_worker_first?: Array<string> | boolean

Contains a list path rules to control routing to either the Worker or assets. Glob (*) and negative (!) rules are supported. Rules must start with either ’/’ or ’!/’. At least one non-negative rule must be provided, and negative rules have higher precedence than non-negative rules.

One of the following:

Array<string>

boolean

jwt?: string

Token provided upon successful upload of all files from a registered manifest.

author_email?: string

Email of the user who created the version.

formatemail

author_id?: string

Identifier of the user who created the version.

bindings?: Array<WorkersBindingKindAI { name, type } | WorkersBindingKindAISearch { instance_name, name, type, namespace } | WorkersBindingKindAISearchNamespace { name, namespace, type } | 35 more>

List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.

One of the following:

WorkersBindingKindAI { name, type }

A JavaScript variable name for the binding.

type: "ai"

The kind of resource that the binding provides.

WorkersBindingKindAISearch { instance_name, name, type, namespace }

instance_name: string

The user-chosen instance name. Must exist at deploy time. The worker can search, chat, update, and manage items/jobs on this instance.

A JavaScript variable name for the binding.

type: "ai_search"

The kind of resource that the binding provides.

namespace?: string

The namespace the instance belongs to. Defaults to “default” if omitted. Customers who don’t use namespaces can simply omit this field.

WorkersBindingKindAISearchNamespace { name, namespace, type }

A JavaScript variable name for the binding.

namespace: string

The user-chosen namespace name. Must exist before deploy — Wrangler handles auto-creation on deploy failure (R2 bucket pattern). The “default” namespace is auto-created by config-api for new accounts. Grants full access (CRUD + search + chat) to all instances within the namespace.

type: "ai_search_namespace"

The kind of resource that the binding provides.

WorkersBindingKindMessaging { name, namespace, type }

A JavaScript variable name for the binding.

namespace: string

The Messaging namespace to bind to.

type: "messaging"

The kind of resource that the binding provides.

WorkersBindingKindAnalyticsEngine { dataset, name, type }

dataset: string

The name of the dataset to bind to.

A JavaScript variable name for the binding.

type: "analytics_engine"

The kind of resource that the binding provides.

WorkersBindingKindArtifacts { name, namespace, type }

A JavaScript variable name for the binding.

namespace: string

The Artifacts namespace exposed to the Worker in the Worker’s account. Must be 2-63 characters, start with an ASCII alphanumeric character, contain only ASCII alphanumeric characters, dots, underscores, and hyphens, and must not end with a hyphen. The namespace does not need to be created before binding it.

maxLength63

minLength2

type: "artifacts"

The kind of resource that the binding provides.

WorkersBindingKindAssets { name, type }

A JavaScript variable name for the binding.

type: "assets"

The kind of resource that the binding provides.

WorkersBindingKindBrowser { name, type }

A JavaScript variable name for the binding.

type: "browser"

The kind of resource that the binding provides.

WorkersBindingKindD1 { database_id, name, type, id }

database_id: string

Identifier of the D1 database to bind to.

A JavaScript variable name for the binding.

type: "d1"

The kind of resource that the binding provides.

Deprecatedid?: string

This property has been renamed to database_id.

Identifier of the D1 database to bind to.

WorkersBindingKindDataBlob { name, part, type }

A JavaScript variable name for the binding.

part: string

The name of the file containing the data content. Only accepted for service worker syntax Workers.

Deprecatedtype: "data_blob"

The kind of resource that the binding provides.

WorkersBindingKindDispatchNamespace { name, namespace, type, outbound }

A JavaScript variable name for the binding.

namespace: string

The name of the dispatch namespace.

type: "dispatch_namespace"

The kind of resource that the binding provides.

outbound?: Outbound { params, worker }

Outbound worker.

params?: Array<Param>

Pass information from the Dispatch Worker to the Outbound Worker through the parameters.

Name of the parameter.

worker?: Worker { entrypoint, environment, service }

Outbound worker.

entrypoint?: string

Entrypoint to invoke on the outbound worker.

environment?: string

Environment of the outbound worker.

service?: string

Name of the outbound worker.

WorkersBindingKindDurableObjectNamespace { name, type, class_name, 5 more }

A JavaScript variable name for the binding.

type: "durable_object_namespace"

The kind of resource that the binding provides.

class_name?: string

The exported class name of the Durable Object.

dispatch_namespace?: string

The dispatch namespace the Durable Object script belongs to.

environment?: string

The environment of the script_name to bind to.

namespace_id?: string

Namespace identifier tag.

maxLength32

retry?: Retry | null

Retry policy for calls made to the Durable Object through this binding. Omitted or null properties use the runtime defaults. These limits are upper bounds and do not enable retries for otherwise ineligible calls.

max_attempts?: number | null

Maximum number of retries after the initial request, not the total number of attempts. Defaults to 4. Zero disables retries.

maximum10

minimum0

timeout_ms?: number | null

Retry timeout in milliseconds, measured from the start of the call. No retry starts after it expires, and a retry still running when it expires is cancelled. This is not a request timeout; it does not limit the initial request, which is still subject to any timeouts set by your Worker. Defaults to 10000.

maximum60000

minimum500

script_name?: string

The script where the Durable Object is defined, if it is external to this Worker.

WorkersBindingKindHyperdrive { id, name, type }

id: string

Identifier of the Hyperdrive connection to bind to.

A JavaScript variable name for the binding.

type: "hyperdrive"

The kind of resource that the binding provides.

WorkersBindingKindInherit { name, type, old_name, version_id }

The name of the inherited binding.

type: "inherit"

The kind of resource that the binding provides.

old_name?: string

The old name of the inherited binding. If set, the binding will be renamed from old_name to name in the new version. If not set, the binding will keep the same name between versions.

version_id?: string

Identifier for the version to inherit the binding from, which can be the version ID or the literal “latest” to inherit from the latest version. Defaults to inheriting the binding from the latest version.

WorkersBindingKindImages { name, type }

A JavaScript variable name for the binding.

type: "images"

The kind of resource that the binding provides.

WorkersBindingKindJson { json, name, type }

json: unknown

JSON data to use.

A JavaScript variable name for the binding.

type: "json"

The kind of resource that the binding provides.

WorkersBindingKindKVNamespace { name, namespace_id, type }

A JavaScript variable name for the binding.

namespace_id: string

Namespace identifier tag.

maxLength32

type: "kv_namespace"

The kind of resource that the binding provides.

WorkersBindingKindMedia { name, type }

A JavaScript variable name for the binding.

type: "media"

The kind of resource that the binding provides.

WorkersBindingKindMTLSCertificate { certificate_id, name, type }

certificate_id: string

Identifier of the certificate to bind to.

A JavaScript variable name for the binding.

type: "mtls_certificate"

The kind of resource that the binding provides.

WorkersBindingKindPlainText { name, text, type }

A JavaScript variable name for the binding.

text: string

The text value to use.

type: "plain_text"

The kind of resource that the binding provides.

WorkersBindingKindPipelines { name, pipeline, type }

A JavaScript variable name for the binding.

pipeline: string

Name of the Pipeline to bind to.

type: "pipelines"

The kind of resource that the binding provides.

WorkersBindingKindK2 { name, stream, type }

A K2 stream binding. Available only to accounts enabled for K2.

A JavaScript variable name for the binding.

stream: string

ID of a K2 stream owned by the account deploying the Worker.

type: "k2"

The kind of resource that the binding provides.

WorkersBindingKindQueue { name, queue_name, type }

A JavaScript variable name for the binding.

queue_name: string

Name of the Queue to bind to.

type: "queue"

The kind of resource that the binding provides.

WorkersBindingKindRatelimit { name, namespace_id, simple, type }

A JavaScript variable name for the binding.

namespace_id: string

Identifier of the rate limit namespace to bind to.

simple: Simple { limit, period, mitigation_timeout }

The rate limit configuration.

limit: number

The limit (requests per period).

period: number

The period in seconds.

mitigation_timeout?: number

Duration in seconds to apply the mitigation action after the rate limit is exceeded. Valid values are 0 (disabled), 10, or multiples of 60 up to 86400. Must be greater than or equal to the period when non-zero.

type: "ratelimit"

The kind of resource that the binding provides.

WorkersBindingKindR2Bucket { bucket_name, name, type, jurisdiction }

bucket_name: string

R2 bucket to bind to.

A JavaScript variable name for the binding.

type: "r2_bucket"

The kind of resource that the binding provides.

jurisdiction?: "eu" | "fedramp" | "fedramp-high" | "us"

The jurisdiction of the R2 bucket.

One of the following:

"eu"

"fedramp"

"fedramp-high"

"us"

WorkersBindingKindSecretText { name, text, type }

A JavaScript variable name for the binding.

text: string

The secret value to use.

type: "secret_text"

The kind of resource that the binding provides.

WorkersBindingKindSendEmail { name, type, allowed_destination_addresses, 2 more }

A JavaScript variable name for the binding.

type: "send_email"

The kind of resource that the binding provides.

allowed_destination_addresses?: Array<string>

List of allowed destination addresses.

allowed_sender_addresses?: Array<string>

List of allowed sender addresses.

destination_address?: string

Destination address for the email.

formatemail

WorkersBindingKindService { name, service, type, 2 more }

A JavaScript variable name for the binding.

service: string

Name of Worker to bind to.

type: "service"

The kind of resource that the binding provides.

entrypoint?: string

Entrypoint to invoke on the target Worker.

environment?: string

Optional environment if the Worker utilizes one.

WorkersBindingKindTextBlob { name, part, type }

A JavaScript variable name for the binding.

part: string

The name of the file containing the text content. Only accepted for service worker syntax Workers.

Deprecatedtype: "text_blob"

The kind of resource that the binding provides.

WorkersBindingKindVectorize { index_name, name, type }

index_name: string

Name of the Vectorize index to bind to.

A JavaScript variable name for the binding.

type: "vectorize"

The kind of resource that the binding provides.

WorkersBindingKindVersionMetadata { name, type }

A JavaScript variable name for the binding.

type: "version_metadata"

The kind of resource that the binding provides.

WorkersBindingKindSecretsStoreSecret { name, secret_name, store_id, type }

A JavaScript variable name for the binding.

secret_name: string

Name of the secret in the store.

store_id: string

ID of the store containing the secret.

type: "secrets_store_secret"

The kind of resource that the binding provides.

WorkersBindingKindFlagship { app_id, name, type }

app_id: string

ID of the Flagship app to bind to for feature flag evaluation.

maxLength128

A JavaScript variable name for the binding.

type: "flagship"

The kind of resource that the binding provides.

WorkersBindingKindSecretKey { algorithm, format, name, 4 more }

algorithm: unknown

Algorithm-specific key parameters. Learn more.

format: "raw" | "pkcs8" | "spki" | "jwk"

Data format of the key. Learn more.

One of the following:

"raw"

"pkcs8"

"spki"

"jwk"

A JavaScript variable name for the binding.

type: "secret_key"

The kind of resource that the binding provides.

usages: Array<"encrypt" | "decrypt" | "sign" | 5 more>

Allowed operations with the key. Learn more.

One of the following:

"encrypt"

"decrypt"

"sign"

"verify"

"deriveKey"

"deriveBits"

"wrapKey"

"unwrapKey"

key_base64?: string

Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”.

key_jwk?: unknown

Key data in JSON Web Key format. Required if format is “jwk”.

WorkersBindingKindWorkflow { name, type, workflow_name, 2 more }

A JavaScript variable name for the binding.

type: "workflow"

The kind of resource that the binding provides.

workflow_name: string

Name of the Workflow to bind to.

class_name?: string

Class name of the Workflow. Should only be provided if the Workflow belongs to this script.

script_name?: string

Script name that contains the Workflow. If not provided, defaults to this script name.

WorkersBindingKindWasmModule { name, part, type }

A JavaScript variable name for the binding.

part: string

The name of the file containing the WebAssembly module content. Only accepted for service worker syntax Workers.

Deprecatedtype: "wasm_module"

The kind of resource that the binding provides.

WorkersBindingKindVPCService { name, service_id, type }

A JavaScript variable name for the binding.

service_id: string

Identifier of the VPC service to bind to.

type: "vpc_service"

The kind of resource that the binding provides.

WorkersBindingKindVPCNetwork { name, type, identity, 2 more }

A JavaScript variable name for the binding.

type: "vpc_network"

The kind of resource that the binding provides.

identity?: "runtime-email-alpha"

Enables Gateway identity for the binding. Requires network_id to be “cf1:network” and cannot be combined with tunnel_id.

network_id?: string

Identifier of the network to bind to. Only “cf1:network” is currently supported. Mutually exclusive with tunnel_id.

tunnel_id?: string

UUID of the Cloudflare Tunnel to bind to. Mutually exclusive with network_id.

cache_options?: CacheOptions { enabled, cross_version_cache }

Global CacheW configuration for the Worker. When caching is on, the platform provisions a cloudflare.app zone for the Worker. A type: worker entry in the exports map can override this value for a single entrypoint.

enabled: boolean

Whether caching is enabled for this Worker.

cross_version_cache?: boolean

Whether cached responses are shared across Worker version uploads. This is independent of enabled. It can stay true while caching is off, so the preference survives turning caching off and back on.

compatibility_date?: string

Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.

compatibility_flags?: Array<string>

Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a compatibility_date.

containers?: Array<Container>

List of containers attached to a Worker. Containers can only be attached to Durable Object classes of this Worker script.

class_name: string

Select which Durable Object class should get this container attached.

exports?: Record<string, WorkersWorkerExport { type, cache, state } | WorkersDurableObjectExport { storage, type, container, state } | WorkersDurableObjectDeletedExport { state, type } | 3 more>

Declarative exports for the version, including Durable Object classes (with their storage backend) and named Worker entrypoints. On reads, tombstoned lifecycle entries are omitted, so only live exports (created and expecting-transfer) are returned. exports and migrations are mutually exclusive on upload.

One of the following:

WorkersWorkerExport { type, cache, state }

A named Worker entrypoint export (type: worker). Worker entrypoints are always live (state: created) and carry no storage or lifecycle fields. The optional cache block overrides the Worker’s global cache_options.enabled for this entrypoint.

type: "worker"

Marks this entry as a Worker entrypoint export.

cache?: Cache { enabled }

Cache override for this entrypoint. Overrides the Worker’s global cache_options.enabled for this entrypoint only.

enabled: boolean

Whether caching is enabled for this entrypoint.

state?: "created"

Live export. May be omitted; defaults to created.

WorkersDurableObjectExport { storage, type, container, state }

A live Durable Object export (state: created, the default). The platform auto-provisions the namespace on first deploy, matches it on subsequent deploys, and never mutates or deletes it as a side effect of a code-only change. storage is required; renamed_to, transferred_to and transfer_from are not allowed on a live entry.

storage: "sqlite" | "legacy-kv"

Durable Object storage backend. sqlite is the recommended (and only) backend for new namespaces. legacy-kv is accepted only for a class whose namespace already exists as KV-backed; the exports flow never provisions a new legacy-kv namespace.

One of the following:

"sqlite"

"legacy-kv"

type: "durable-object"

Marks this entry as a Durable Object export.

container?: string

Name of the container (declared in the upload’s metadata.containers) that backs this Durable Object. When set, the namespace is container-enabled. Valid only on live entries.

maxLength128

state?: "created"

Live export. May be omitted; defaults to created.

WorkersDurableObjectDeletedExport { state, type }

A deleted tombstone: retires the provisioned namespace for this class and all of its data. The class must be absent from the uploaded code and no other Worker in the account may bind to the namespace, otherwise the deploy is rejected. No other fields are allowed. Deletion is irreversible.

state: "deleted"

Tombstone that deletes the namespace.

type: "durable-object"

Marks this entry as a Durable Object export.

WorkersDurableObjectRenamedExport { renamed_to, state, type }

A renamed tombstone: rewrites the provisioned namespace’s class name from this map key to renamed_to. The source class may stay in code during the rollout window (an info notice is emitted). storage, transferred_to and transfer_from are not allowed.

renamed_to: string

The destination class name. Must differ from the source class (the map key) and must be declared as a live (created) entry in the same exports map. Write-only: never present in GET responses.

maxLength128

state: "renamed"

Tombstone that renames the namespace’s class.

type: "durable-object"

Marks this entry as a Durable Object export.

WorkersDurableObjectTransferredExport { state, transferred_to, type }

A transferred tombstone (source side of a two-phase transfer): hands ownership of the provisioned namespace to another script in the same account, named by transferred_to. The target must have already deployed a matching expecting-transfer entry. The source class may stay in code during the rollout window (an info notice is emitted). storage, renamed_to and transfer_from are not allowed.

state: "transferred"

Tombstone that transfers the namespace to another script.

transferred_to: string

The destination script name. Must be in the same account and the same dispatch-namespace context (or both non-dispatch). Cross-dispatch-namespace transfers are rejected. Write-only: never present in GET responses.

maxLength128

type: "durable-object"

Marks this entry as a Durable Object export.

WorkersDurableObjectExpectingTransferExport { state, storage, transfer_from, 2 more }

The target side of a two-phase transfer (state: expecting-transfer). Declares that this script expects to receive a namespace for this class from the transfer_from script. This is a live entry, not a tombstone: bindings resolve through the source’s namespace until the source commits with a transferred tombstone. storage and transfer_from are required; renamed_to and transferred_to are not allowed.

state: "expecting-transfer"

Target side of a two-phase transfer.

storage: "sqlite" | "legacy-kv"

One of the following:

"sqlite"

"legacy-kv"

transfer_from: string

The source script name to receive the namespace from. Must be in the same account and dispatch-namespace context. Present on reads for expecting-transfer entries.

maxLength128

type: "durable-object"

Marks this entry as a Durable Object export.

container?: string

Name of the container (declared in the upload’s metadata.containers) that backs this Durable Object once the transfer settles. Valid only on live entries.

maxLength128

exports_reconciliation?: ExportsReconciliation { created, deleted, info, 6 more }

Summary of the declarative exports reconciliation that ran on this upload. Populated only when the uploaded metadata included an exports block. Durable Object entries drive reconciliation; type: worker entries do not contribute to this summary.

created: Array<string>

Class names for which a new namespace was provisioned.

deleted: Array<string>

Class names whose namespace was deleted by a deleted tombstone.

info: Array<Info>

Non-blocking info entries (stale tombstones, tombstone applied with class still in code). See exports_reconciliation_info.

The class name the info entry is about.

message: string

Human-readable explanation.

scenario: "code_class_not_in_exports" | "provisioned_class_missing_from_config" | "config_export_not_in_code" | 30 more

Stable, machine-readable tag identifying which reconciliation scenario produced an error, warning, or info entry. Clients may branch on this value instead of parsing message.

One of the following:

"code_class_not_in_exports"

"provisioned_class_missing_from_config"

"config_export_not_in_code"

"config_references_nonexistent_class"

"orphaned_provisioned_namespace"

"storage_type_mismatch"

"free_tier_requires_sqlite"

"invalid_export"

"tombstone_delete_class_still_in_code"

"tombstone_delete_blocked_by_external_bindings"

"tombstone_renamed_to_occupied"

"transferred_pending_not_found"

"transferred_target_missing"

"transferred_target_mismatch"

"phase_one_transfer_source_missing"

"phase_one_transfer_source_namespace_missing"

"phase_one_transfer_target_class_provisioned"

"phase_one_transfer_after_commit_mismatch"

"phase_one_transfer_duplicate"

"phase_one_transfer_target_in_dispatch_namespace"

"phase_one_transfer_source_in_dispatch_namespace"

"transferred_source_in_dispatch_namespace"

"transferred_target_in_dispatch_namespace"

"container_undeclared_reference"

"container_class_not_durable_object"

"container_wiring_inconsistent"

"container_multiple_durable_objects"

"transfer_container_parity_mismatch"

"transfer_container_parity_mismatch_on_commit"

"tombstone_class_still_in_code"

"stale_tombstone"

"transfer_receive_already_applied"

"transfer_receive_cleanup_complete"

namespace_id?: string

The provisioned namespace the entry relates to, when applicable.

formatuuid

referencing_scripts?: Array<string>

Other Workers in the account that still bind to the affected class. Advisory: while non-empty the tombstone is not yet safe to remove — redeploy these Workers with bindings re-pointed first.

removable_entries: Array<string>

Source class names whose tombstone entry is now stale and safe to delete from exports (no remaining referencing scripts).

renamed: Array<Renamed>

Applied renamed tombstones.

from: string

The original (source) class name.

to: string

The new class name (renamed_to).

transfer_pending: Array<TransferPending>

Phase-1 transfer hints recorded on the target side.

The target-side class name awaiting transfer.

from: string

The source script the namespace will be transferred from.

transferred: Array<Transferred>

Committed transferred tombstones (phase-2).

The source class name that was transferred.

phase: "committed"

The transfer phase. Currently always committed.

to: string

The destination script that now owns the namespace.

updated: Array<string>

Class names whose provisioned namespace was mutated in place.

warnings: Array<Warning>

Non-blocking warnings. See exports_reconciliation_warning.

The class name the warning is about.

message: string

Human-readable explanation of the warning.

scenario: "code_class_not_in_exports" | "provisioned_class_missing_from_config" | "config_export_not_in_code" | 30 more

Stable, machine-readable tag identifying which reconciliation scenario produced an error, warning, or info entry. Clients may branch on this value instead of parsing message.

One of the following:

"code_class_not_in_exports"

"provisioned_class_missing_from_config"

"config_export_not_in_code"

"config_references_nonexistent_class"

"orphaned_provisioned_namespace"

"storage_type_mismatch"

"free_tier_requires_sqlite"

"invalid_export"

"tombstone_delete_class_still_in_code"

"tombstone_delete_blocked_by_external_bindings"

"tombstone_renamed_to_occupied"

"transferred_pending_not_found"

"transferred_target_missing"

"transferred_target_mismatch"

"phase_one_transfer_source_missing"

"phase_one_transfer_source_namespace_missing"

"phase_one_transfer_target_class_provisioned"

"phase_one_transfer_after_commit_mismatch"

"phase_one_transfer_duplicate"

"phase_one_transfer_target_in_dispatch_namespace"

"phase_one_transfer_source_in_dispatch_namespace"

"transferred_source_in_dispatch_namespace"

"transferred_target_in_dispatch_namespace"

"container_undeclared_reference"

"container_class_not_durable_object"

"container_wiring_inconsistent"

"container_multiple_durable_objects"

"transfer_container_parity_mismatch"

"transfer_container_parity_mismatch_on_commit"

"tombstone_class_still_in_code"

"stale_tombstone"

"transfer_receive_already_applied"

"transfer_receive_cleanup_complete"

namespace_id?: string

The provisioned namespace the warning relates to, when applicable.

formatuuid

limits?: Limits { cpu_ms, subrequests }

Resource limits enforced at runtime.

cpu_ms?: number

CPU time limit in milliseconds.

subrequests?: number

Subrequest limit per request.

main_module?: string

The name of the main module in the modules array (e.g. the name of the module that exports a fetch handler).

migration_tag?: string

Durable Object migration tag. Set when the version is deployed. Omitted if the version has not been deployed or the Worker does not use Durable Objects.

migrations?: SingleStepMigration { deleted_classes, new_classes, new_sqlite_classes, 4 more } | WorkersMultipleStepMigrations { new_tag, old_tag, steps }

Migrations for Durable Objects associated with the version. Migrations are applied when the version is deployed.

One of the following:

SingleStepMigration { deleted_classes, new_classes, new_sqlite_classes, 4 more }

A single set of migrations to apply.

deleted_classes?: Array<string>

A list of classes to delete Durable Object namespaces from.

new_classes?: Array<string>

A list of classes to create Durable Object namespaces from.

new_sqlite_classes?: Array<string>

A list of classes to create Durable Object namespaces with SQLite from.

new_tag?: string

Tag to set as the latest migration tag.

old_tag?: string

Tag used to verify against the latest migration tag for this Worker. If they don’t match, the upload is rejected.

renamed_classes?: Array<RenamedClass>

A list of classes with Durable Object namespaces that were renamed.

from?: string

to?: string

transferred_classes?: Array<TransferredClass>

A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker.

from?: string

from_script?: string

to?: string

WorkersMultipleStepMigrations { new_tag, old_tag, steps }

new_tag?: string

Tag to set as the latest migration tag.

old_tag?: string

Tag used to verify against the latest migration tag for this Worker. If they don’t match, the upload is rejected.

steps?: Array<MigrationStep { deleted_classes, new_classes, new_sqlite_classes, 2 more } >

Migrations to apply in order.

deleted_classes?: Array<string>

A list of classes to delete Durable Object namespaces from.

new_classes?: Array<string>

A list of classes to create Durable Object namespaces from.

new_sqlite_classes?: Array<string>

A list of classes to create Durable Object namespaces with SQLite from.

renamed_classes?: Array<RenamedClass>

A list of classes with Durable Object namespaces that were renamed.

from?: string

to?: string

transferred_classes?: Array<TransferredClass>

A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker.

from?: string

from_script?: string

to?: string

modules?: Array<Module>

Code, sourcemaps, and other content used at runtime.

This includes _headers and _redirects files used to configure Static Assets. _headers and _redirects files should be included as modules named _headers and _redirects with content type text/plain.

content_base64: string

The base64-encoded module content.

formatbyte

content_type: string

The content type of the module.

The name of the module.

package_dependencies?: Array<PackageDependency>

The list of npm packages that were installed and used when this Worker version was built.

installedVersion: string

The exact version that was resolved and installed by the package manager.

The npm package name.

packageJsonVersion: string

The version constraint as written in package.json.

placement?: Mode { mode } | Region { region } | Hostname { hostname } | 5 more

Configuration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host.

One of the following:

Mode { mode }

mode: "smart"

Enables Smart Placement.

Region { region }

region: string

Cloud region for targeted placement in format ‘provider:region’.

Hostname { hostname }

hostname: string

HTTP hostname for targeted placement.

Host { host }

host: string

TCP host and port for targeted placement.

UnionMember4 { mode, region }

mode: "targeted"

Targeted placement mode.

region: string

Cloud region for targeted placement in format ‘provider:region’.

UnionMember5 { hostname, mode }

hostname: string

HTTP hostname for targeted placement.

mode: "targeted"

Targeted placement mode.

UnionMember6 { host, mode }

host: string

TCP host and port for targeted placement.

mode: "targeted"

Targeted placement mode.

UnionMember7 { mode, target }

mode: "targeted"

Targeted placement mode.

target: Array<Region { region } | Hostname { hostname } | Host { host } >

Array of placement targets (currently limited to single target).

One of the following:

Region { region }

region: string

Cloud region in format ‘provider:region’.

Hostname { hostname }

hostname: string

HTTP hostname for targeted placement.

Host { host }

host: string

TCP host:port for targeted placement.

source?: string

The client used to create the version.

startup_time_ms?: number

Time in milliseconds spent on Worker startup.

Deprecatedusage_model?: "standard" | "bundled" | "unbound"

Usage model for the version.

One of the following:

"standard"

"bundled"

"unbound"

VersionDeleteResponse { errors, messages, success }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

WorkersRoutes

List Worker Routes

client.workers.routes.list(, ?): SinglePage<RouteListResponse { id, pattern, script } >

GET/zones/{zone_id}/workers/routes

Get Worker Route

client.workers.routes.get(, , ?): RouteGetResponse { id, pattern, script }

GET/zones/{zone_id}/workers/routes/{route_id}

Create Worker Route

client.workers.routes.create(, ?): RouteCreateResponse { id, pattern, script }

POST/zones/{zone_id}/workers/routes

Replace Worker Route

client.workers.routes.update(, , ?): RouteUpdateResponse { id, pattern, script }

PUT/zones/{zone_id}/workers/routes/{route_id}

Delete Worker Route

client.workers.routes.delete(, , ?): RouteDeleteResponse { id }

DELETE/zones/{zone_id}/workers/routes/{route_id}

ModelsExpand Collapse

RouteListResponse { id, pattern, script }

id: string

Identifier.

maxLength32

pattern: string

Pattern to match incoming requests against. Learn more.

script?: string

Name of the script to run if the route matches.

RouteGetResponse { id, pattern, script }

id: string

Identifier.

maxLength32

pattern: string

Pattern to match incoming requests against. Learn more.

script?: string

Name of the script to run if the route matches.

RouteCreateResponse { id, pattern, script }

id: string

Identifier.

maxLength32

pattern: string

Pattern to match incoming requests against. Learn more.

script?: string

Name of the script to run if the route matches.

RouteUpdateResponse { id, pattern, script }

id: string

Identifier.

maxLength32

pattern: string

Pattern to match incoming requests against. Learn more.

script?: string

Name of the script to run if the route matches.

RouteDeleteResponse { id }

id?: string

Identifier.

maxLength32

WorkersAssets

WorkersAssetsUpload

Upload Worker Assets

client.workers.assets.upload.create(, ?): UploadCreateResponse { jwt }

POST/accounts/{account_id}/workers/assets/upload

ModelsExpand Collapse

UploadCreateResponse { jwt }

jwt?: string

A “completion” JWT which can be redeemed when creating a Worker version.

WorkersScripts

List Worker Scripts

client.workers.scripts.list(, ?): SinglePage<ScriptListResponse { id, cache_options, compatibility_date, 21 more } >

GET/accounts/{account_id}/workers/scripts

Search Worker Scripts

client.workers.scripts.search(, ?): ScriptSearchResponse { id, created_on, modified_on, 4 more }

GET/accounts/{account_id}/workers/scripts-search

Download Worker Script

client.workers.scripts.get(, , ?): ScriptGetResponse

GET/accounts/{account_id}/workers/scripts/{script_name}

Upload Worker Module

client.workers.scripts.update(, , ?): ScriptUpdateResponse { startup_time_ms, id, cache_options, 22 more }

PUT/accounts/{account_id}/workers/scripts/{script_name}

Delete Worker

client.workers.scripts.delete(, , ?): ScriptDeleteResponse | null

DELETE/accounts/{account_id}/workers/scripts/{script_name}

ModelsExpand Collapse

Script { id, cache_options, compatibility_date, 20 more }

id?: string

The name used to identify the script.

cache_options?: CacheOptions { enabled, cross_version_cache }

enabled: boolean

Whether caching is enabled for this Worker.

cross_version_cache?: boolean

Whether cached responses are shared across Worker version uploads. This is independent of enabled. It can stay true while caching is off, so the preference survives turning caching off and back on.

compatibility_date?: string

Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.

compatibility_flags?: Array<string>

Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a compatibility_date.

created_on?: string

When the script was created.

formatdate-time

etag?: string

Hashed script content, can be used in a If-None-Match header when updating.

exports?: Record<string, WorkersWorkerExport { type, cache, state } | WorkersDurableObjectExport { storage, type, container, state } | WorkersDurableObjectDeletedExport { state, type } | 3 more>

Declarative exports for the Worker’s most recent version, including Durable Object classes (with their storage backend) and named Worker entrypoints. Tombstoned lifecycle entries are omitted, so only live exports (created and expecting-transfer) are returned.

One of the following:

WorkersWorkerExport { type, cache, state }

type: "worker"

Marks this entry as a Worker entrypoint export.

cache?: Cache { enabled }

Cache override for this entrypoint. Overrides the Worker’s global cache_options.enabled for this entrypoint only.

enabled: boolean

Whether caching is enabled for this entrypoint.

state?: "created"

Live export. May be omitted; defaults to created.

WorkersDurableObjectExport { storage, type, container, state }

storage: "sqlite" | "legacy-kv"

One of the following:

"sqlite"

"legacy-kv"

type: "durable-object"

Marks this entry as a Durable Object export.

container?: string

Name of the container (declared in the upload’s metadata.containers) that backs this Durable Object. When set, the namespace is container-enabled. Valid only on live entries.

maxLength128

state?: "created"

Live export. May be omitted; defaults to created.

WorkersDurableObjectDeletedExport { state, type }

state: "deleted"

Tombstone that deletes the namespace.

type: "durable-object"

Marks this entry as a Durable Object export.

WorkersDurableObjectRenamedExport { renamed_to, state, type }

renamed_to: string

The destination class name. Must differ from the source class (the map key) and must be declared as a live (created) entry in the same exports map. Write-only: never present in GET responses.

maxLength128

state: "renamed"

Tombstone that renames the namespace’s class.

type: "durable-object"

Marks this entry as a Durable Object export.

WorkersDurableObjectTransferredExport { state, transferred_to, type }

state: "transferred"

Tombstone that transfers the namespace to another script.

transferred_to: string

maxLength128

type: "durable-object"

Marks this entry as a Durable Object export.

WorkersDurableObjectExpectingTransferExport { state, storage, transfer_from, 2 more }

state: "expecting-transfer"

Target side of a two-phase transfer.

storage: "sqlite" | "legacy-kv"

One of the following:

"sqlite"

"legacy-kv"

transfer_from: string

The source script name to receive the namespace from. Must be in the same account and dispatch-namespace context. Present on reads for expecting-transfer entries.

maxLength128

type: "durable-object"

Marks this entry as a Durable Object export.

container?: string

Name of the container (declared in the upload’s metadata.containers) that backs this Durable Object once the transfer settles. Valid only on live entries.

maxLength128

handlers?: Array<string>

The names of handlers exported as part of the default export.

has_assets?: boolean

Whether a Worker contains assets.

has_modules?: boolean

Whether a Worker contains modules.

last_deployed_from?: string

The client most recently used to deploy this Worker.

logpush?: boolean

Whether Logpush is turned on for the Worker.

migration_tag?: string

The tag of the Durable Object migration that was most recently applied for this Worker.

modified_on?: string

When the script was last modified.

formatdate-time

named_handlers?: Array<NamedHandler>

Named exports, such as Durable Object class implementations and named entrypoints.

handlers?: Array<string>

The names of handlers exported as part of the named export.

name?: string

The name of the export.

observability?: Observability { enabled, head_sampling_rate, issues, 3 more }

Observability settings for the Worker.

enabled: boolean

Whether observability is enabled for the Worker.

head_sampling_rate?: number | null

The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.

issues?: Issues | null

Real-time Issues settings for the Worker.

enabled?: boolean

Whether real-time Issues are enabled for the Worker.

logs?: Logs | null

Log settings for the Worker.

enabled: boolean

Whether logs are enabled for the Worker.

invocation_logs: boolean

Whether invocation logs are enabled for the Worker.

destinations?: Array<string>

A list of destinations where logs will be exported to.

head_sampling_rate?: number | null

The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.

persist?: boolean

Whether log persistence is enabled for the Worker.

redact_query_string?: boolean

Whether query strings are removed from request URLs in logs and traces.

traces?: Traces | null

Trace settings for the Worker.

destinations?: Array<string>

A list of destinations where traces will be exported to.

enabled?: boolean

Whether traces are enabled for the Worker.

head_sampling_rate?: number | null

The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.

persist?: boolean

Whether trace persistence is enabled for the Worker.

propagation_policy?: "authenticated" | "accept" | null

One of the following:

"authenticated"

"accept"

placement?: UnionMember0 { mode, last_analyzed_at, status } | UnionMember1 { region, last_analyzed_at, status } | UnionMember2 { hostname, last_analyzed_at, status } | 5 more

Configuration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host.

One of the following:

UnionMember0 { mode, last_analyzed_at, status }

mode: "smart"

Enables Smart Placement.

last_analyzed_at?: string

The last time the script was analyzed for Smart Placement.

formatdate-time

status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

UnionMember1 { region, last_analyzed_at, status }

region: string

Cloud region for targeted placement in format ‘provider:region’.

last_analyzed_at?: string

The last time the script was analyzed for Smart Placement.

formatdate-time

status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

UnionMember2 { hostname, last_analyzed_at, status }

hostname: string

HTTP hostname for targeted placement.

last_analyzed_at?: string

The last time the script was analyzed for Smart Placement.

formatdate-time

status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

UnionMember3 { host, last_analyzed_at, status }

host: string

TCP host and port for targeted placement.

last_analyzed_at?: string

The last time the script was analyzed for Smart Placement.

formatdate-time

status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

UnionMember4 { mode, region, last_analyzed_at, status }

mode: "targeted"

Targeted placement mode.

region: string

Cloud region for targeted placement in format ‘provider:region’.

last_analyzed_at?: string

The last time the script was analyzed for Smart Placement.

formatdate-time

status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

UnionMember5 { hostname, mode, last_analyzed_at, status }

hostname: string

HTTP hostname for targeted placement.

mode: "targeted"

Targeted placement mode.

last_analyzed_at?: string

The last time the script was analyzed for Smart Placement.

formatdate-time

status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

UnionMember6 { host, mode, last_analyzed_at, status }

host: string

TCP host and port for targeted placement.

mode: "targeted"

Targeted placement mode.

last_analyzed_at?: string

The last time the script was analyzed for Smart Placement.

formatdate-time

status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

UnionMember7 { mode, target, last_analyzed_at, status }

mode: "targeted"

Targeted placement mode.

target: Array<Region { region } | Hostname { hostname } | Host { host } >

Array of placement targets (currently limited to single target).

One of the following:

Region { region }

region: string

Cloud region in format ‘provider:region’.

Hostname { hostname }

hostname: string

HTTP hostname for targeted placement.

Host { host }

host: string

TCP host:port for targeted placement.

last_analyzed_at?: string

The last time the script was analyzed for Smart Placement.

formatdate-time

status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

Deprecatedplacement_mode?: "smart" | "targeted"

Configuration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host.

One of the following:

"smart"

"targeted"

Deprecatedplacement_status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

tag?: string

The immutable ID of the script.

tags?: Array<string> | null

Tags associated with the Worker.

tail_consumers?: Array<ConsumerScript { service, environment, namespace } > | null

List of Workers that will consume logs from the attached Worker.

service: string

Name of Worker that is to be the consumer.

environment?: string

Optional environment if the Worker utilizes one.

namespace?: string

Optional dispatch namespace the script belongs to.

usage_model?: "standard" | "bundled" | "unbound"

Usage model for the Worker invocations.

One of the following:

"standard"

"bundled"

"unbound"

ScriptSetting { logpush, observability, tags, tail_consumers }

logpush?: boolean

Whether Logpush is turned on for the Worker.

observability?: Observability | null

Observability settings for the Worker.

enabled: boolean

Whether observability is enabled for the Worker.

head_sampling_rate?: number | null

The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.

issues?: Issues | null

Real-time Issues settings for the Worker.

enabled?: boolean

Whether real-time Issues are enabled for the Worker.

logs?: Logs | null

Log settings for the Worker.

enabled: boolean

Whether logs are enabled for the Worker.

invocation_logs: boolean

Whether invocation logs are enabled for the Worker.

destinations?: Array<string>

A list of destinations where logs will be exported to.

head_sampling_rate?: number | null

The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.

persist?: boolean

Whether log persistence is enabled for the Worker.

redact_query_string?: boolean

Whether query strings are removed from request URLs in logs and traces.

traces?: Traces | null

Trace settings for the Worker.

destinations?: Array<string>

A list of destinations where traces will be exported to.

enabled?: boolean

Whether traces are enabled for the Worker.

head_sampling_rate?: number | null

The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.

persist?: boolean

Whether trace persistence is enabled for the Worker.

propagation_policy?: "authenticated" | "accept" | null

One of the following:

"authenticated"

"accept"

tags?: Array<string> | null

Tags associated with the Worker.

tail_consumers?: Array<ConsumerScript { service, environment, namespace } > | null

List of Workers that will consume logs from the attached Worker.

service: string

Name of Worker that is to be the consumer.

environment?: string

Optional environment if the Worker utilizes one.

namespace?: string

Optional dispatch namespace the script belongs to.

ScriptListResponse { id, cache_options, compatibility_date, 21 more }

id?: string

The name used to identify the script.

cache_options?: CacheOptions { enabled, cross_version_cache }

enabled: boolean

Whether caching is enabled for this Worker.

cross_version_cache?: boolean

Whether cached responses are shared across Worker version uploads. This is independent of enabled. It can stay true while caching is off, so the preference survives turning caching off and back on.

compatibility_date?: string

Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.

compatibility_flags?: Array<string>

Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a compatibility_date.

created_on?: string

When the script was created.

formatdate-time

etag?: string

Hashed script content, can be used in a If-None-Match header when updating.

exports?: Record<string, WorkersWorkerExport { type, cache, state } | WorkersDurableObjectExport { storage, type, container, state } | WorkersDurableObjectDeletedExport { state, type } | 3 more>

One of the following:

WorkersWorkerExport { type, cache, state }

type: "worker"

Marks this entry as a Worker entrypoint export.

cache?: Cache { enabled }

Cache override for this entrypoint. Overrides the Worker’s global cache_options.enabled for this entrypoint only.

enabled: boolean

Whether caching is enabled for this entrypoint.

state?: "created"

Live export. May be omitted; defaults to created.

WorkersDurableObjectExport { storage, type, container, state }

storage: "sqlite" | "legacy-kv"

One of the following:

"sqlite"

"legacy-kv"

type: "durable-object"

Marks this entry as a Durable Object export.

container?: string

Name of the container (declared in the upload’s metadata.containers) that backs this Durable Object. When set, the namespace is container-enabled. Valid only on live entries.

maxLength128

state?: "created"

Live export. May be omitted; defaults to created.

WorkersDurableObjectDeletedExport { state, type }

state: "deleted"

Tombstone that deletes the namespace.

type: "durable-object"

Marks this entry as a Durable Object export.

WorkersDurableObjectRenamedExport { renamed_to, state, type }

renamed_to: string

The destination class name. Must differ from the source class (the map key) and must be declared as a live (created) entry in the same exports map. Write-only: never present in GET responses.

maxLength128

state: "renamed"

Tombstone that renames the namespace’s class.

type: "durable-object"

Marks this entry as a Durable Object export.

WorkersDurableObjectTransferredExport { state, transferred_to, type }

state: "transferred"

Tombstone that transfers the namespace to another script.

transferred_to: string

maxLength128

type: "durable-object"

Marks this entry as a Durable Object export.

WorkersDurableObjectExpectingTransferExport { state, storage, transfer_from, 2 more }

state: "expecting-transfer"

Target side of a two-phase transfer.

storage: "sqlite" | "legacy-kv"

One of the following:

"sqlite"

"legacy-kv"

transfer_from: string

The source script name to receive the namespace from. Must be in the same account and dispatch-namespace context. Present on reads for expecting-transfer entries.

maxLength128

type: "durable-object"

Marks this entry as a Durable Object export.

container?: string

Name of the container (declared in the upload’s metadata.containers) that backs this Durable Object once the transfer settles. Valid only on live entries.

maxLength128

handlers?: Array<string>

The names of handlers exported as part of the default export.

has_assets?: boolean

Whether a Worker contains assets.

has_modules?: boolean

Whether a Worker contains modules.

last_deployed_from?: string

The client most recently used to deploy this Worker.

logpush?: boolean

Whether Logpush is turned on for the Worker.

migration_tag?: string

The tag of the Durable Object migration that was most recently applied for this Worker.

modified_on?: string

When the script was last modified.

formatdate-time

named_handlers?: Array<NamedHandler>

Named exports, such as Durable Object class implementations and named entrypoints.

handlers?: Array<string>

The names of handlers exported as part of the named export.

name?: string

The name of the export.

observability?: Observability { enabled, head_sampling_rate, issues, 3 more }

Observability settings for the Worker.

enabled: boolean

Whether observability is enabled for the Worker.

head_sampling_rate?: number | null

The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.

issues?: Issues | null

Real-time Issues settings for the Worker.

enabled?: boolean

Whether real-time Issues are enabled for the Worker.

logs?: Logs | null

Log settings for the Worker.

enabled: boolean

Whether logs are enabled for the Worker.

invocation_logs: boolean

Whether invocation logs are enabled for the Worker.

destinations?: Array<string>

A list of destinations where logs will be exported to.

head_sampling_rate?: number | null

The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.

persist?: boolean

Whether log persistence is enabled for the Worker.

redact_query_string?: boolean

Whether query strings are removed from request URLs in logs and traces.

traces?: Traces | null

Trace settings for the Worker.

destinations?: Array<string>

A list of destinations where traces will be exported to.

enabled?: boolean

Whether traces are enabled for the Worker.

head_sampling_rate?: number | null

The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.

persist?: boolean

Whether trace persistence is enabled for the Worker.

propagation_policy?: "authenticated" | "accept" | null

One of the following:

"authenticated"

"accept"

placement?: UnionMember0 { mode, last_analyzed_at, status } | UnionMember1 { region, last_analyzed_at, status } | UnionMember2 { hostname, last_analyzed_at, status } | 5 more

Configuration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host.

One of the following:

UnionMember0 { mode, last_analyzed_at, status }

mode: "smart"

Enables Smart Placement.

last_analyzed_at?: string

The last time the script was analyzed for Smart Placement.

formatdate-time

status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

UnionMember1 { region, last_analyzed_at, status }

region: string

Cloud region for targeted placement in format ‘provider:region’.

last_analyzed_at?: string

The last time the script was analyzed for Smart Placement.

formatdate-time

status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

UnionMember2 { hostname, last_analyzed_at, status }

hostname: string

HTTP hostname for targeted placement.

last_analyzed_at?: string

The last time the script was analyzed for Smart Placement.

formatdate-time

status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

UnionMember3 { host, last_analyzed_at, status }

host: string

TCP host and port for targeted placement.

last_analyzed_at?: string

The last time the script was analyzed for Smart Placement.

formatdate-time

status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

UnionMember4 { mode, region, last_analyzed_at, status }

mode: "targeted"

Targeted placement mode.

region: string

Cloud region for targeted placement in format ‘provider:region’.

last_analyzed_at?: string

The last time the script was analyzed for Smart Placement.

formatdate-time

status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

UnionMember5 { hostname, mode, last_analyzed_at, status }

hostname: string

HTTP hostname for targeted placement.

mode: "targeted"

Targeted placement mode.

last_analyzed_at?: string

The last time the script was analyzed for Smart Placement.

formatdate-time

status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

UnionMember6 { host, mode, last_analyzed_at, status }

host: string

TCP host and port for targeted placement.

mode: "targeted"

Targeted placement mode.

last_analyzed_at?: string

The last time the script was analyzed for Smart Placement.

formatdate-time

status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

UnionMember7 { mode, target, last_analyzed_at, status }

mode: "targeted"

Targeted placement mode.

target: Array<Region { region } | Hostname { hostname } | Host { host } >

Array of placement targets (currently limited to single target).

One of the following:

Region { region }

region: string

Cloud region in format ‘provider:region’.

Hostname { hostname }

hostname: string

HTTP hostname for targeted placement.

Host { host }

host: string

TCP host:port for targeted placement.

last_analyzed_at?: string

The last time the script was analyzed for Smart Placement.

formatdate-time

status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

Deprecatedplacement_mode?: "smart" | "targeted"

One of the following:

"smart"

"targeted"

Deprecatedplacement_status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

routes?: Array<Route> | null

Routes associated with the Worker.

id: string

Identifier.

maxLength32

pattern: string

Pattern to match incoming requests against. Learn more.

script?: string

Name of the script to run if the route matches.

tag?: string

The immutable ID of the script.

tags?: Array<string> | null

Tags associated with the Worker.

tail_consumers?: Array<ConsumerScript { service, environment, namespace } > | null

List of Workers that will consume logs from the attached Worker.

service: string

Name of Worker that is to be the consumer.

environment?: string

Optional environment if the Worker utilizes one.

namespace?: string

Optional dispatch namespace the script belongs to.

usage_model?: "standard" | "bundled" | "unbound"

Usage model for the Worker invocations.

One of the following:

"standard"

"bundled"

"unbound"

ScriptSearchResponse = Array<ScriptSearchResponseItem>

id: string

Identifier.

maxLength32

created_on: string

When the script was created.

formatdate-time

modified_on: string

When the script was last modified.

formatdate-time

script_name: string

Name of the script.

environment_is_default?: boolean

Whether the environment is the default environment.

environment_name?: string

Name of the environment.

service_name?: string

Name of the service.

ScriptGetResponse = string

ScriptUpdateResponse { startup_time_ms, id, cache_options, 22 more }

startup_time_ms: number

id?: string

The name used to identify the script.

cache_options?: CacheOptions { enabled, cross_version_cache }

enabled: boolean

Whether caching is enabled for this Worker.

cross_version_cache?: boolean

Whether cached responses are shared across Worker version uploads. This is independent of enabled. It can stay true while caching is off, so the preference survives turning caching off and back on.

compatibility_date?: string

Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.

compatibility_flags?: Array<string>

Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a compatibility_date.

created_on?: string

When the script was created.

formatdate-time

entry_point?: string

The entry point for the script.

etag?: string

Hashed script content, can be used in a If-None-Match header when updating.

exports?: Record<string, WorkersWorkerExport { type, cache, state } | WorkersDurableObjectExport { storage, type, container, state } | WorkersDurableObjectDeletedExport { state, type } | 3 more>

One of the following:

WorkersWorkerExport { type, cache, state }

type: "worker"

Marks this entry as a Worker entrypoint export.

cache?: Cache { enabled }

Cache override for this entrypoint. Overrides the Worker’s global cache_options.enabled for this entrypoint only.

enabled: boolean

Whether caching is enabled for this entrypoint.

state?: "created"

Live export. May be omitted; defaults to created.

WorkersDurableObjectExport { storage, type, container, state }

storage: "sqlite" | "legacy-kv"

One of the following:

"sqlite"

"legacy-kv"

type: "durable-object"

Marks this entry as a Durable Object export.

container?: string

Name of the container (declared in the upload’s metadata.containers) that backs this Durable Object. When set, the namespace is container-enabled. Valid only on live entries.

maxLength128

state?: "created"

Live export. May be omitted; defaults to created.

WorkersDurableObjectDeletedExport { state, type }

state: "deleted"

Tombstone that deletes the namespace.

type: "durable-object"

Marks this entry as a Durable Object export.

WorkersDurableObjectRenamedExport { renamed_to, state, type }

renamed_to: string

The destination class name. Must differ from the source class (the map key) and must be declared as a live (created) entry in the same exports map. Write-only: never present in GET responses.

maxLength128

state: "renamed"

Tombstone that renames the namespace’s class.

type: "durable-object"

Marks this entry as a Durable Object export.

WorkersDurableObjectTransferredExport { state, transferred_to, type }

state: "transferred"

Tombstone that transfers the namespace to another script.

transferred_to: string

maxLength128

type: "durable-object"

Marks this entry as a Durable Object export.

WorkersDurableObjectExpectingTransferExport { state, storage, transfer_from, 2 more }

state: "expecting-transfer"

Target side of a two-phase transfer.

storage: "sqlite" | "legacy-kv"

One of the following:

"sqlite"

"legacy-kv"

transfer_from: string

The source script name to receive the namespace from. Must be in the same account and dispatch-namespace context. Present on reads for expecting-transfer entries.

maxLength128

type: "durable-object"

Marks this entry as a Durable Object export.

container?: string

Name of the container (declared in the upload’s metadata.containers) that backs this Durable Object once the transfer settles. Valid only on live entries.

maxLength128

handlers?: Array<string>

The names of handlers exported as part of the default export.

has_assets?: boolean

Whether a Worker contains assets.

has_modules?: boolean

Whether a Worker contains modules.

last_deployed_from?: string

The client most recently used to deploy this Worker.

logpush?: boolean

Whether Logpush is turned on for the Worker.

migration_tag?: string

The tag of the Durable Object migration that was most recently applied for this Worker.

modified_on?: string

When the script was last modified.

formatdate-time

named_handlers?: Array<NamedHandler>

Named exports, such as Durable Object class implementations and named entrypoints.

handlers?: Array<string>

The names of handlers exported as part of the named export.

name?: string

The name of the export.

observability?: Observability { enabled, head_sampling_rate, issues, 3 more }

Observability settings for the Worker.

enabled: boolean

Whether observability is enabled for the Worker.

head_sampling_rate?: number | null

The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.

issues?: Issues | null

Real-time Issues settings for the Worker.

enabled?: boolean

Whether real-time Issues are enabled for the Worker.

logs?: Logs | null

Log settings for the Worker.

enabled: boolean

Whether logs are enabled for the Worker.

invocation_logs: boolean

Whether invocation logs are enabled for the Worker.

destinations?: Array<string>

A list of destinations where logs will be exported to.

head_sampling_rate?: number | null

The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.

persist?: boolean

Whether log persistence is enabled for the Worker.

redact_query_string?: boolean

Whether query strings are removed from request URLs in logs and traces.

traces?: Traces | null

Trace settings for the Worker.

destinations?: Array<string>

A list of destinations where traces will be exported to.

enabled?: boolean

Whether traces are enabled for the Worker.

head_sampling_rate?: number | null

The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.

persist?: boolean

Whether trace persistence is enabled for the Worker.

propagation_policy?: "authenticated" | "accept" | null

One of the following:

"authenticated"

"accept"

placement?: UnionMember0 { mode, last_analyzed_at, status } | UnionMember1 { region, last_analyzed_at, status } | UnionMember2 { hostname, last_analyzed_at, status } | 5 more

Configuration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host.

One of the following:

UnionMember0 { mode, last_analyzed_at, status }

mode: "smart"

Enables Smart Placement.

last_analyzed_at?: string

The last time the script was analyzed for Smart Placement.

formatdate-time

status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

UnionMember1 { region, last_analyzed_at, status }

region: string

Cloud region for targeted placement in format ‘provider:region’.

last_analyzed_at?: string

The last time the script was analyzed for Smart Placement.

formatdate-time

status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

UnionMember2 { hostname, last_analyzed_at, status }

hostname: string

HTTP hostname for targeted placement.

last_analyzed_at?: string

The last time the script was analyzed for Smart Placement.

formatdate-time

status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

UnionMember3 { host, last_analyzed_at, status }

host: string

TCP host and port for targeted placement.

last_analyzed_at?: string

The last time the script was analyzed for Smart Placement.

formatdate-time

status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

UnionMember4 { mode, region, last_analyzed_at, status }

mode: "targeted"

Targeted placement mode.

region: string

Cloud region for targeted placement in format ‘provider:region’.

last_analyzed_at?: string

The last time the script was analyzed for Smart Placement.

formatdate-time

status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

UnionMember5 { hostname, mode, last_analyzed_at, status }

hostname: string

HTTP hostname for targeted placement.

mode: "targeted"

Targeted placement mode.

last_analyzed_at?: string

The last time the script was analyzed for Smart Placement.

formatdate-time

status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

UnionMember6 { host, mode, last_analyzed_at, status }

host: string

TCP host and port for targeted placement.

mode: "targeted"

Targeted placement mode.

last_analyzed_at?: string

The last time the script was analyzed for Smart Placement.

formatdate-time

status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

UnionMember7 { mode, target, last_analyzed_at, status }

mode: "targeted"

Targeted placement mode.

target: Array<Region { region } | Hostname { hostname } | Host { host } >

Array of placement targets (currently limited to single target).

One of the following:

Region { region }

region: string

Cloud region in format ‘provider:region’.

Hostname { hostname }

hostname: string

HTTP hostname for targeted placement.

Host { host }

host: string

TCP host:port for targeted placement.

last_analyzed_at?: string

The last time the script was analyzed for Smart Placement.

formatdate-time

status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

Status of Smart Placement.

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

Deprecatedplacement_mode?: "smart" | "targeted"

One of the following:

"smart"

"targeted"

Deprecatedplacement_status?: "SUCCESS" | "UNSUPPORTED_APPLICATION" | "INSUFFICIENT_INVOCATIONS"

One of the following:

"SUCCESS"

"UNSUPPORTED_APPLICATION"

"INSUFFICIENT_INVOCATIONS"

tag?: string

The immutable ID of the script.

tags?: Array<string> | null

Tags associated with the Worker.

tail_consumers?: Array<ConsumerScript { service, environment, namespace } > | null

List of Workers that will consume logs from the attached Worker.

service: string

Name of Worker that is to be the consumer.

environment?: string

Optional environment if the Worker utilizes one.

namespace?: string

Optional dispatch namespace the script belongs to.

usage_model?: "standard" | "bundled" | "unbound"

Usage model for the Worker invocations.

One of the following:

"standard"

"bundled"

"unbound"

ScriptDeleteResponse = unknown

WorkersScriptsAssets

WorkersScriptsAssetsUpload

Create Worker Assets Upload Session

client.workers.scripts.assets.upload.create(, , ?): UploadCreateResponse { buckets, jwt }

POST/accounts/{account_id}/workers/scripts/{script_name}/assets-upload-session

ModelsExpand Collapse

UploadCreateResponse { buckets, jwt }

buckets?: Array<Array<string>>

The requests to make to upload assets.

jwt?: string

A JWT to use as authentication for uploading assets.

WorkersScriptsSubdomain

Get Worker Script Subdomain

client.workers.scripts.subdomain.get(, , ?): SubdomainGetResponse { enabled, previews_enabled }

GET/accounts/{account_id}/workers/scripts/{script_name}/subdomain

Update Worker Script Subdomain

client.workers.scripts.subdomain.create(, , ?): SubdomainCreateResponse { enabled, previews_enabled }

POST/accounts/{account_id}/workers/scripts/{script_name}/subdomain

Delete Worker Script Subdomain

client.workers.scripts.subdomain.delete(, , ?): SubdomainDeleteResponse { enabled, previews_enabled }

DELETE/accounts/{account_id}/workers/scripts/{script_name}/subdomain

ModelsExpand Collapse

SubdomainGetResponse { enabled, previews_enabled }

enabled: boolean

Whether the Worker is available on the workers.dev subdomain.

previews_enabled: boolean

Whether the Worker’s Preview URLs are available on the workers.dev subdomain.

SubdomainCreateResponse { enabled, previews_enabled }

enabled: boolean

Whether the Worker is available on the workers.dev subdomain.

previews_enabled: boolean

Whether the Worker’s Preview URLs are available on the workers.dev subdomain.

SubdomainDeleteResponse { enabled, previews_enabled }

enabled: boolean

Whether the Worker is available on the workers.dev subdomain.

previews_enabled: boolean

Whether the Worker’s Preview URLs are available on the workers.dev subdomain.

WorkersScriptsSchedules

Get Worker Script Schedules (Cron Triggers)

client.workers.scripts.schedules.get(, , ?): ScheduleGetResponse { schedules }

GET/accounts/{account_id}/workers/scripts/{script_name}/schedules

Update Worker Script Schedules (Cron Triggers)

client.workers.scripts.schedules.update(, , ?): ScheduleUpdateResponse { schedules }

PUT/accounts/{account_id}/workers/scripts/{script_name}/schedules

ModelsExpand Collapse

ScheduleGetResponse { schedules }

schedules: Array<Schedule>

cron: string

created_on?: string

modified_on?: string

ScheduleUpdateResponse { schedules }

schedules: Array<Schedule>

cron: string

created_on?: string

modified_on?: string

WorkersScriptsTail

List Worker Tails

client.workers.scripts.tail.get(, , ?): TailGetResponse { id, expires_at, url }

GET/accounts/{account_id}/workers/scripts/{script_name}/tails

Start Worker Tail

client.workers.scripts.tail.create(, , ?): TailCreateResponse { id, expires_at, url }

POST/accounts/{account_id}/workers/scripts/{script_name}/tails

Delete Worker Tail

client.workers.scripts.tail.delete(, , ?): TailDeleteResponse { errors, messages, success }

DELETE/accounts/{account_id}/workers/scripts/{script_name}/tails/{id}

ModelsExpand Collapse

ConsumerScript { service, environment, namespace }

A reference to a script that will consume logs from the attached Worker.

service: string

Name of Worker that is to be the consumer.

environment?: string

Optional environment if the Worker utilizes one.

namespace?: string

Optional dispatch namespace the script belongs to.

TailGetResponse { id, expires_at, url }

id: string

Identifier.

maxLength32

expires_at: string

url: string

TailCreateResponse { id, expires_at, url }

id: string

Identifier.

maxLength32

expires_at: string

url: string

TailDeleteResponse { errors, messages, success }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

WorkersScriptsContent

Get Worker Script Content

client.workers.scripts.content.get(, , ?): Response

GET/accounts/{account_id}/workers/scripts/{script_name}/content/v2

Replace Worker Script Content

client.workers.scripts.content.update(, , ?): Script { id, cache_options, compatibility_date, 20 more }

PUT/accounts/{account_id}/workers/scripts/{script_name}/content

WorkersScriptsSettings

Get Worker Script Settings

client.workers.scripts.settings.get(, , ?): ScriptSetting { logpush, observability, tags, tail_consumers }

GET/accounts/{account_id}/workers/scripts/{script_name}/script-settings

Patch Worker Script Settings

client.workers.scripts.settings.edit(, , ?): ScriptSetting { logpush, observability, tags, tail_consumers }

PATCH/accounts/{account_id}/workers/scripts/{script_name}/script-settings

WorkersScriptsDeployments

List Worker Deployments

client.workers.scripts.deployments.list(, , ?): V4PagePagination<DeploymentListResponse { deployments } >

GET/accounts/{account_id}/workers/scripts/{script_name}/deployments

Create Worker Deployment

client.workers.scripts.deployments.create(, , ?): Deployment { id, created_on, source, 4 more }

POST/accounts/{account_id}/workers/scripts/{script_name}/deployments

Get Worker Deployment

client.workers.scripts.deployments.get(, , ?): Deployment { id, created_on, source, 4 more }

GET/accounts/{account_id}/workers/scripts/{script_name}/deployments/{deployment_id}

Delete Worker Deployment

client.workers.scripts.deployments.delete(, , ?): DeploymentDeleteResponse { errors, messages, success }

DELETE/accounts/{account_id}/workers/scripts/{script_name}/deployments/{deployment_id}

ModelsExpand Collapse

Deployment { id, created_on, source, 4 more }

id: string

formatuuid

created_on: string

formatdate-time

source: string

strategy: "percentage"

versions: Array<Version>

Worker versions included in this deployment. Each object must contain a version_id UUID and a percentage; percentages across all objects must total 100. In the cf CLI, pass the entire array as one JSON value to --versions, either inline, for example --versions '[{"version_id":"023e105f-2a42-4f8b-a1c1-73f6a2a30c0f","percentage":100}]', or from a JSON file with --versions @versions.json.

percentage: number

Percentage of traffic served by this version.

maximum100

minimum0.01

version_id: string

Identifier of the Worker Version.

formatuuid

annotations?: Annotations { workers/message, workers/triggered_by }

"workers/message"?: string

Human-readable message about the deployment. Truncated to 1000 bytes if longer.

maxLength1000

"workers/triggered_by"?: string

Operation that triggered the creation of the deployment.

author_email?: string

formatemail

DeploymentListResponse { deployments }

deployments: Array<Deployment { id, created_on, source, 4 more } >

id: string

formatuuid

created_on: string

formatdate-time

source: string

strategy: "percentage"

versions: Array<Version>

percentage: number

Percentage of traffic served by this version.

maximum100

minimum0.01

version_id: string

Identifier of the Worker Version.

formatuuid

annotations?: Annotations { workers/message, workers/triggered_by }

"workers/message"?: string

Human-readable message about the deployment. Truncated to 1000 bytes if longer.

maxLength1000

"workers/triggered_by"?: string

Operation that triggered the creation of the deployment.

author_email?: string

formatemail

DeploymentDeleteResponse { errors, messages, success }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

WorkersScriptsVersions

List Versions

client.workers.scripts.versions.list(, , ?): V4PagePagination<VersionListResponse { id, metadata, number } >

GET/accounts/{account_id}/workers/scripts/{script_name}/versions

Get Worker Script Version

client.workers.scripts.versions.get(, , ?): VersionGetResponse { resources, id, metadata, number }

GET/accounts/{account_id}/workers/scripts/{script_name}/versions/{version_id}

Upload Version

client.workers.scripts.versions.create(, , ?): VersionCreateResponse { resources, id, exports_reconciliation, 3 more }

POST/accounts/{account_id}/workers/scripts/{script_name}/versions

ModelsExpand Collapse

VersionListResponse { id, metadata, number }

id?: string

Unique identifier for the version.

metadata?: Metadata { author_email, author_id, created_on, 3 more }

author_email?: string

Email of the user who created the version.

author_id?: string

Identifier of the user who created the version.

created_on?: string

When the version was created.

hasPreview?: boolean

Whether the version can be previewed.

modified_on?: string

When the version was last modified.

source?: "unknown" | "api" | "wrangler" | 8 more

The source of the version upload.

One of the following:

"unknown"

"api"

"wrangler"

"terraform"

"dash"

"cf_cli"

"dash_template"

"integration"

"quick_editor"

"playground"

"workersci"

number?: number

Sequential version number.

VersionGetResponse { resources, id, metadata, number }

resources: Resources { bindings, script, script_runtime }

bindings?: Bindings

List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.

script?: Script { etag, handlers, last_deployed_from, named_handlers }

etag?: string

Hashed script content

handlers?: Array<string>

The names of handlers exported as part of the default export.

last_deployed_from?: string

The client most recently used to deploy this Worker.

named_handlers?: Array<NamedHandler>

Named exports, such as Durable Object class implementations and named entrypoints.

handlers?: Array<string>

The names of handlers exported as part of the named export.

name?: string

The name of the exported class or entrypoint.

script_runtime?: ScriptRuntime { compatibility_date, compatibility_flags, exports, 3 more }

Runtime configuration for the Worker.

compatibility_date?: string

Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.

compatibility_flags?: Array<string>

Flags that enable or disable certain features in the Workers runtime.

exports?: Record<string, WorkersWorkerExport { type, cache, state } | WorkersDurableObjectExport { storage, type, container, state } | WorkersDurableObjectDeletedExport { state, type } | 3 more>

Declarative exports for this version, including Durable Object classes (with their storage backend) and named Worker entrypoints. Tombstoned lifecycle entries are omitted, so only live exports (created and expecting-transfer) are returned.

One of the following:

WorkersWorkerExport { type, cache, state }

type: "worker"

Marks this entry as a Worker entrypoint export.

cache?: Cache { enabled }

Cache override for this entrypoint. Overrides the Worker’s global cache_options.enabled for this entrypoint only.

enabled: boolean

Whether caching is enabled for this entrypoint.

state?: "created"

Live export. May be omitted; defaults to created.

WorkersDurableObjectExport { storage, type, container, state }

storage: "sqlite" | "legacy-kv"

One of the following:

"sqlite"

"legacy-kv"

type: "durable-object"

Marks this entry as a Durable Object export.

container?: string

Name of the container (declared in the upload’s metadata.containers) that backs this Durable Object. When set, the namespace is container-enabled. Valid only on live entries.

maxLength128

state?: "created"

Live export. May be omitted; defaults to created.

WorkersDurableObjectDeletedExport { state, type }

state: "deleted"

Tombstone that deletes the namespace.

type: "durable-object"

Marks this entry as a Durable Object export.

WorkersDurableObjectRenamedExport { renamed_to, state, type }

renamed_to: string

The destination class name. Must differ from the source class (the map key) and must be declared as a live (created) entry in the same exports map. Write-only: never present in GET responses.

maxLength128

state: "renamed"

Tombstone that renames the namespace’s class.

type: "durable-object"

Marks this entry as a Durable Object export.

WorkersDurableObjectTransferredExport { state, transferred_to, type }

state: "transferred"

Tombstone that transfers the namespace to another script.

transferred_to: string

maxLength128

type: "durable-object"

Marks this entry as a Durable Object export.

WorkersDurableObjectExpectingTransferExport { state, storage, transfer_from, 2 more }

state: "expecting-transfer"

Target side of a two-phase transfer.

storage: "sqlite" | "legacy-kv"

One of the following:

"sqlite"

"legacy-kv"

transfer_from: string

The source script name to receive the namespace from. Must be in the same account and dispatch-namespace context. Present on reads for expecting-transfer entries.

maxLength128

type: "durable-object"

Marks this entry as a Durable Object export.

container?: string

Name of the container (declared in the upload’s metadata.containers) that backs this Durable Object once the transfer settles. Valid only on live entries.

maxLength128

limits?: Limits { cpu_ms }

Resource limits for the Worker.

cpu_ms?: number

The amount of CPU time this Worker can use in milliseconds.

migration_tag?: string

The tag of the Durable Object migration that was most recently applied for this Worker.

usage_model?: "bundled" | "unbound" | "standard"

Usage model for the Worker invocations.

One of the following:

"bundled"

"unbound"

"standard"

id?: string

Unique identifier for the version.

metadata?: Metadata { author_email, author_id, created_on, 3 more }

author_email?: string

Email of the user who created the version.

author_id?: string

Identifier of the user who created the version.

created_on?: string

When the version was created.

hasPreview?: boolean

Whether the version can be previewed.

modified_on?: string

When the version was last modified.

source?: "unknown" | "api" | "wrangler" | 8 more

The source of the version upload.

One of the following:

"unknown"

"api"

"wrangler"

"terraform"

"dash"

"cf_cli"

"dash_template"

"integration"

"quick_editor"

"playground"

"workersci"

number?: number

Sequential version number.

VersionCreateResponse { resources, id, exports_reconciliation, 3 more }

resources: Resources { bindings, script, script_runtime }

bindings?: Bindings

List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.

script?: Script { etag, handlers, last_deployed_from, named_handlers }

etag?: string

Hashed script content

handlers?: Array<string>

The names of handlers exported as part of the default export.

last_deployed_from?: string

The client most recently used to deploy this Worker.

named_handlers?: Array<NamedHandler>

Named exports, such as Durable Object class implementations and named entrypoints.

handlers?: Array<string>

The names of handlers exported as part of the named export.

name?: string

The name of the exported class or entrypoint.

script_runtime?: ScriptRuntime { compatibility_date, compatibility_flags, exports, 3 more }

Runtime configuration for the Worker.

compatibility_date?: string

Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.

compatibility_flags?: Array<string>

Flags that enable or disable certain features in the Workers runtime.

exports?: Record<string, WorkersWorkerExport { type, cache, state } | WorkersDurableObjectExport { storage, type, container, state } | WorkersDurableObjectDeletedExport { state, type } | 3 more>

One of the following:

WorkersWorkerExport { type, cache, state }

type: "worker"

Marks this entry as a Worker entrypoint export.

cache?: Cache { enabled }

Cache override for this entrypoint. Overrides the Worker’s global cache_options.enabled for this entrypoint only.

enabled: boolean

Whether caching is enabled for this entrypoint.

state?: "created"

Live export. May be omitted; defaults to created.

WorkersDurableObjectExport { storage, type, container, state }

storage: "sqlite" | "legacy-kv"

One of the following:

"sqlite"

"legacy-kv"

type: "durable-object"

Marks this entry as a Durable Object export.

container?: string

Name of the container (declared in the upload’s metadata.containers) that backs this Durable Object. When set, the namespace is container-enabled. Valid only on live entries.

maxLength128

state?: "created"

Live export. May be omitted; defaults to created.

WorkersDurableObjectDeletedExport { state, type }

state: "deleted"

Tombstone that deletes the namespace.

type: "durable-object"

Marks this entry as a Durable Object export.

WorkersDurableObjectRenamedExport { renamed_to, state, type }

renamed_to: string

The destination class name. Must differ from the source class (the map key) and must be declared as a live (created) entry in the same exports map. Write-only: never present in GET responses.

maxLength128

state: "renamed"

Tombstone that renames the namespace’s class.

type: "durable-object"

Marks this entry as a Durable Object export.

WorkersDurableObjectTransferredExport { state, transferred_to, type }

state: "transferred"

Tombstone that transfers the namespace to another script.

transferred_to: string

maxLength128

type: "durable-object"

Marks this entry as a Durable Object export.

WorkersDurableObjectExpectingTransferExport { state, storage, transfer_from, 2 more }

state: "expecting-transfer"

Target side of a two-phase transfer.

storage: "sqlite" | "legacy-kv"

One of the following:

"sqlite"

"legacy-kv"

transfer_from: string

The source script name to receive the namespace from. Must be in the same account and dispatch-namespace context. Present on reads for expecting-transfer entries.

maxLength128

type: "durable-object"

Marks this entry as a Durable Object export.

container?: string

Name of the container (declared in the upload’s metadata.containers) that backs this Durable Object once the transfer settles. Valid only on live entries.

maxLength128

limits?: Limits { cpu_ms }

Resource limits for the Worker.

cpu_ms?: number

The amount of CPU time this Worker can use in milliseconds.

migration_tag?: string

The tag of the Durable Object migration that was most recently applied for this Worker.

usage_model?: "bundled" | "unbound" | "standard"

Usage model for the Worker invocations.

One of the following:

"bundled"

"unbound"

"standard"

id?: string

Unique identifier for the version.

exports_reconciliation?: ExportsReconciliation { created, deleted, info, 6 more }

created: Array<string>

Class names for which a new namespace was provisioned.

deleted: Array<string>

Class names whose namespace was deleted by a deleted tombstone.

info: Array<Info>

Non-blocking info entries (stale tombstones, tombstone applied with class still in code). See exports_reconciliation_info.

The class name the info entry is about.

message: string

Human-readable explanation.

scenario: "code_class_not_in_exports" | "provisioned_class_missing_from_config" | "config_export_not_in_code" | 30 more

Stable, machine-readable tag identifying which reconciliation scenario produced an error, warning, or info entry. Clients may branch on this value instead of parsing message.

One of the following:

"code_class_not_in_exports"

"provisioned_class_missing_from_config"

"config_export_not_in_code"

"config_references_nonexistent_class"

"orphaned_provisioned_namespace"

"storage_type_mismatch"

"free_tier_requires_sqlite"

"invalid_export"

"tombstone_delete_class_still_in_code"

"tombstone_delete_blocked_by_external_bindings"

"tombstone_renamed_to_occupied"

"transferred_pending_not_found"

"transferred_target_missing"

"transferred_target_mismatch"

"phase_one_transfer_source_missing"

"phase_one_transfer_source_namespace_missing"

"phase_one_transfer_target_class_provisioned"

"phase_one_transfer_after_commit_mismatch"

"phase_one_transfer_duplicate"

"phase_one_transfer_target_in_dispatch_namespace"

"phase_one_transfer_source_in_dispatch_namespace"

"transferred_source_in_dispatch_namespace"

"transferred_target_in_dispatch_namespace"

"container_undeclared_reference"

"container_class_not_durable_object"

"container_wiring_inconsistent"

"container_multiple_durable_objects"

"transfer_container_parity_mismatch"

"transfer_container_parity_mismatch_on_commit"

"tombstone_class_still_in_code"

"stale_tombstone"

"transfer_receive_already_applied"

"transfer_receive_cleanup_complete"

namespace_id?: string

The provisioned namespace the entry relates to, when applicable.

formatuuid

referencing_scripts?: Array<string>

Other Workers in the account that still bind to the affected class. Advisory: while non-empty the tombstone is not yet safe to remove — redeploy these Workers with bindings re-pointed first.

removable_entries: Array<string>

Source class names whose tombstone entry is now stale and safe to delete from exports (no remaining referencing scripts).

renamed: Array<Renamed>

Applied renamed tombstones.

from: string

The original (source) class name.

to: string

The new class name (renamed_to).

transfer_pending: Array<TransferPending>

Phase-1 transfer hints recorded on the target side.

The target-side class name awaiting transfer.

from: string

The source script the namespace will be transferred from.

transferred: Array<Transferred>

Committed transferred tombstones (phase-2).

The source class name that was transferred.

phase: "committed"

The transfer phase. Currently always committed.

to: string

The destination script that now owns the namespace.

updated: Array<string>

Class names whose provisioned namespace was mutated in place.

warnings: Array<Warning>

Non-blocking warnings. See exports_reconciliation_warning.

The class name the warning is about.

message: string

Human-readable explanation of the warning.

scenario: "code_class_not_in_exports" | "provisioned_class_missing_from_config" | "config_export_not_in_code" | 30 more

Stable, machine-readable tag identifying which reconciliation scenario produced an error, warning, or info entry. Clients may branch on this value instead of parsing message.

One of the following:

"code_class_not_in_exports"

"provisioned_class_missing_from_config"

"config_export_not_in_code"

"config_references_nonexistent_class"

"orphaned_provisioned_namespace"

"storage_type_mismatch"

"free_tier_requires_sqlite"

"invalid_export"

"tombstone_delete_class_still_in_code"

"tombstone_delete_blocked_by_external_bindings"

"tombstone_renamed_to_occupied"

"transferred_pending_not_found"

"transferred_target_missing"

"transferred_target_mismatch"

"phase_one_transfer_source_missing"

"phase_one_transfer_source_namespace_missing"

"phase_one_transfer_target_class_provisioned"

"phase_one_transfer_after_commit_mismatch"

"phase_one_transfer_duplicate"

"phase_one_transfer_target_in_dispatch_namespace"

"phase_one_transfer_source_in_dispatch_namespace"

"transferred_source_in_dispatch_namespace"

"transferred_target_in_dispatch_namespace"

"container_undeclared_reference"

"container_class_not_durable_object"

"container_wiring_inconsistent"

"container_multiple_durable_objects"

"transfer_container_parity_mismatch"

"transfer_container_parity_mismatch_on_commit"

"tombstone_class_still_in_code"

"stale_tombstone"

"transfer_receive_already_applied"

"transfer_receive_cleanup_complete"

namespace_id?: string

The provisioned namespace the warning relates to, when applicable.

formatuuid

metadata?: Metadata { author_email, author_id, created_on, 3 more }

author_email?: string

Email of the user who created the version.

author_id?: string

Identifier of the user who created the version.

created_on?: string

When the version was created.

hasPreview?: boolean

Whether the version can be previewed.

modified_on?: string

When the version was last modified.

source?: "unknown" | "api" | "wrangler" | 8 more

The source of the version upload.

One of the following:

"unknown"

"api"

"wrangler"

"terraform"

"dash"

"cf_cli"

"dash_template"

"integration"

"quick_editor"

"playground"

"workersci"

number?: number

Sequential version number.

startup_time_ms?: number

Time in milliseconds spent on Worker startup.

WorkersScriptsSecrets

List secrets bound to a Worker script

client.workers.scripts.secrets.list(, , ?): SinglePage<SecretListResponse>

GET/accounts/{account_id}/workers/scripts/{script_name}/secrets

Get a secret binding

client.workers.scripts.secrets.get(, , ?): SecretGetResponse

GET/accounts/{account_id}/workers/scripts/{script_name}/secrets/{secret_name}

Add a secret to a Worker script

client.workers.scripts.secrets.update(, , ?): SecretUpdateResponse

PUT/accounts/{account_id}/workers/scripts/{script_name}/secrets

Delete Worker script secret

client.workers.scripts.secrets.delete(, , ?): SecretDeleteResponse | null

DELETE/accounts/{account_id}/workers/scripts/{script_name}/secrets/{secret_name}

Patch multiple Worker script secrets

client.workers.scripts.secrets.bulkUpdate(, , ?): SecretBulkUpdateResponse { , }

PATCH/accounts/{account_id}/workers/scripts/{script_name}/secrets-bulk

ModelsExpand Collapse

SecretListResponse = WorkersBindingKindSecretText { name, text, type } | WorkersBindingKindSecretKey { algorithm, format, name, 4 more }

A secret value accessible through a binding.

One of the following:

WorkersBindingKindSecretText { name, text, type }

A JavaScript variable name for the binding.

text: string

The secret value to use.

type: "secret_text"

The kind of resource that the binding provides.

WorkersBindingKindSecretKey { algorithm, format, name, 4 more }

algorithm: unknown

Algorithm-specific key parameters. Learn more.

format: "raw" | "pkcs8" | "spki" | "jwk"

Data format of the key. Learn more.

One of the following:

"raw"

"pkcs8"

"spki"

"jwk"

A JavaScript variable name for the binding.

type: "secret_key"

The kind of resource that the binding provides.

usages: Array<"encrypt" | "decrypt" | "sign" | 5 more>

Allowed operations with the key. Learn more.

One of the following:

"encrypt"

"decrypt"

"sign"

"verify"

"deriveKey"

"deriveBits"

"wrapKey"

"unwrapKey"

key_base64?: string

Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”.

key_jwk?: unknown

Key data in JSON Web Key format. Required if format is “jwk”.

SecretGetResponse = WorkersBindingKindSecretText { name, text, type } | WorkersBindingKindSecretKey { algorithm, format, name, 4 more }

A secret value accessible through a binding.

One of the following:

WorkersBindingKindSecretText { name, text, type }

A JavaScript variable name for the binding.

text: string

The secret value to use.

type: "secret_text"

The kind of resource that the binding provides.

WorkersBindingKindSecretKey { algorithm, format, name, 4 more }

algorithm: unknown

Algorithm-specific key parameters. Learn more.

format: "raw" | "pkcs8" | "spki" | "jwk"

Data format of the key. Learn more.

One of the following:

"raw"

"pkcs8"

"spki"

"jwk"

A JavaScript variable name for the binding.

type: "secret_key"

The kind of resource that the binding provides.

usages: Array<"encrypt" | "decrypt" | "sign" | 5 more>

Allowed operations with the key. Learn more.

One of the following:

"encrypt"

"decrypt"

"sign"

"verify"

"deriveKey"

"deriveBits"

"wrapKey"

"unwrapKey"

key_base64?: string

Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”.

key_jwk?: unknown

Key data in JSON Web Key format. Required if format is “jwk”.

SecretUpdateResponse = WorkersBindingKindSecretText { name, text, type } | WorkersBindingKindSecretKey { algorithm, format, name, 4 more }

A secret value accessible through a binding.

One of the following:

WorkersBindingKindSecretText { name, text, type }

A JavaScript variable name for the binding.

text: string

The secret value to use.

type: "secret_text"

The kind of resource that the binding provides.

WorkersBindingKindSecretKey { algorithm, format, name, 4 more }

algorithm: unknown

Algorithm-specific key parameters. Learn more.

format: "raw" | "pkcs8" | "spki" | "jwk"

Data format of the key. Learn more.

One of the following:

"raw"

"pkcs8"

"spki"

"jwk"

A JavaScript variable name for the binding.

type: "secret_key"

The kind of resource that the binding provides.

usages: Array<"encrypt" | "decrypt" | "sign" | 5 more>

Allowed operations with the key. Learn more.

One of the following:

"encrypt"

"decrypt"

"sign"

"verify"

"deriveKey"

"deriveBits"

"wrapKey"

"unwrapKey"

key_base64?: string

Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”.

key_jwk?: unknown

Key data in JSON Web Key format. Required if format is “jwk”.

SecretDeleteResponse = unknown

SecretBulkUpdateResponse = Record<string, WorkersBindingKindSecretText { name, text, type } | WorkersBindingKindSecretKey { algorithm, format, name, 4 more } >

Map of secret names to secret metadata for resulting secrets.

One of the following:

WorkersBindingKindSecretText { name, text, type }

A JavaScript variable name for the binding.

text: string

The secret value to use.

type: "secret_text"

The kind of resource that the binding provides.

WorkersBindingKindSecretKey { algorithm, format, name, 4 more }

algorithm: unknown

Algorithm-specific key parameters. Learn more.

format: "raw" | "pkcs8" | "spki" | "jwk"

Data format of the key. Learn more.

One of the following:

"raw"

"pkcs8"

"spki"

"jwk"

A JavaScript variable name for the binding.

type: "secret_key"

The kind of resource that the binding provides.

usages: Array<"encrypt" | "decrypt" | "sign" | 5 more>

Allowed operations with the key. Learn more.

One of the following:

"encrypt"

"decrypt"

"sign"

"verify"

"deriveKey"

"deriveBits"

"wrapKey"

"unwrapKey"

key_base64?: string

Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”.

key_jwk?: unknown

Key data in JSON Web Key format. Required if format is “jwk”.

WorkersScriptsScript And Version Settings

Get Worker Script and Version Settings

client.workers.scripts.scriptAndVersionSettings.get(, , ?): ScriptAndVersionSettingGetResponse { annotations, bindings, cache_options, 12 more }

GET/accounts/{account_id}/workers/scripts/{script_name}/settings

Patch Worker Script and Version Settings

client.workers.scripts.scriptAndVersionSettings.edit(, , ?): ScriptAndVersionSettingEditResponse { annotations, bindings, cache_options, 12 more }

PATCH/accounts/{account_id}/workers/scripts/{script_name}/settings

ModelsExpand Collapse

ScriptAndVersionSettingGetResponse { annotations, bindings, cache_options, 12 more }

annotations?: Annotations { workers/message, workers/tag, workers/triggered_by }

Annotations for the Worker version. Annotations are not inherited across settings updates; omitting this field means the new version will have no annotations.

"workers/message"?: string

Human-readable message about the version. Truncated to 1000 bytes if longer.

maxLength1000

"workers/tag"?: string

User-provided identifier for the version. Maximum 100 bytes.

maxLength100

"workers/triggered_by"?: string

Operation that triggered the creation of the version. This is read-only and set by the server.

bindings?: Array<WorkersBindingKindAI { name, type } | WorkersBindingKindAISearch { instance_name, name, type, namespace } | WorkersBindingKindAISearchNamespace { name, namespace, type } | 35 more>

List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.

One of the following:

WorkersBindingKindAI { name, type }

A JavaScript variable name for the binding.

type: "ai"

The kind of resource that the binding provides.

WorkersBindingKindAISearch { instance_name, name, type, namespace }

instance_name: string

The user-chosen instance name. Must exist at deploy time. The worker can search, chat, update, and manage items/jobs on this instance.

A JavaScript variable name for the binding.

type: "ai_search"

The kind of resource that the binding provides.

namespace?: string

The namespace the instance belongs to. Defaults to “default” if omitted. Customers who don’t use namespaces can simply omit this field.

WorkersBindingKindAISearchNamespace { name, namespace, type }

A JavaScript variable name for the binding.

namespace: string

type: "ai_search_namespace"

The kind of resource that the binding provides.

WorkersBindingKindMessaging { name, namespace, type }

A JavaScript variable name for the binding.

namespace: string

The Messaging namespace to bind to.

type: "messaging"

The kind of resource that the binding provides.

WorkersBindingKindAnalyticsEngine { dataset, name, type }

dataset: string

The name of the dataset to bind to.

A JavaScript variable name for the binding.

type: "analytics_engine"

The kind of resource that the binding provides.

WorkersBindingKindArtifacts { name, namespace, type }

A JavaScript variable name for the binding.

namespace: string

maxLength63

minLength2

type: "artifacts"

The kind of resource that the binding provides.

WorkersBindingKindAssets { name, type }

A JavaScript variable name for the binding.

type: "assets"

The kind of resource that the binding provides.

WorkersBindingKindBrowser { name, type }

A JavaScript variable name for the binding.

type: "browser"

The kind of resource that the binding provides.

WorkersBindingKindD1 { database_id, name, type, id }

database_id: string

Identifier of the D1 database to bind to.

A JavaScript variable name for the binding.

type: "d1"

The kind of resource that the binding provides.

Deprecatedid?: string

This property has been renamed to database_id.

Identifier of the D1 database to bind to.

WorkersBindingKindDataBlob { name, part, type }

A JavaScript variable name for the binding.

part: string

The name of the file containing the data content. Only accepted for service worker syntax Workers.

Deprecatedtype: "data_blob"

The kind of resource that the binding provides.

WorkersBindingKindDispatchNamespace { name, namespace, type, outbound }

A JavaScript variable name for the binding.

namespace: string

The name of the dispatch namespace.

type: "dispatch_namespace"

The kind of resource that the binding provides.

outbound?: Outbound { params, worker }

Outbound worker.

params?: Array<Param>

Pass information from the Dispatch Worker to the Outbound Worker through the parameters.

Name of the parameter.

worker?: Worker { entrypoint, environment, service }

Outbound worker.

entrypoint?: string

Entrypoint to invoke on the outbound worker.

environment?: string

Environment of the outbound worker.

service?: string

Name of the outbound worker.

WorkersBindingKindDurableObjectNamespace { name, type, class_name, 5 more }

A JavaScript variable name for the binding.

type: "durable_object_namespace"

The kind of resource that the binding provides.

class_name?: string

The exported class name of the Durable Object.

dispatch_namespace?: string

The dispatch namespace the Durable Object script belongs to.

environment?: string

The environment of the script_name to bind to.

namespace_id?: string

Namespace identifier tag.

maxLength32

retry?: Retry | null

max_attempts?: number | null

Maximum number of retries after the initial request, not the total number of attempts. Defaults to 4. Zero disables retries.

maximum10

minimum0

timeout_ms?: number | null

maximum60000

minimum500

script_name?: string

The script where the Durable Object is defined, if it is external to this Worker.

WorkersBindingKindHyperdrive { id, name, type }

id: string

Identifier of the Hyperdrive connection to bind to.

A JavaScript variable name for the binding.

type: "hyperdrive"

The kind of resource that the binding provides.

WorkersBindingKindInherit { name, type, old_name, version_id }

The name of the inherited binding.

type: "inherit"

The kind of resource that the binding provides.

old_name?: string

The old name of the inherited binding. If set, the binding will be renamed from old_name to name in the new version. If not set, the binding will keep the same name between versions.

version_id?: string

WorkersBindingKindImages { name, type }

A JavaScript variable name for the binding.

type: "images"

The kind of resource that the binding provides.

WorkersBindingKindJson { json, name, type }

json: unknown

JSON data to use.

A JavaScript variable name for the binding.

type: "json"

The kind of resource that the binding provides.

WorkersBindingKindKVNamespace { name, namespace_id, type }

A JavaScript variable name for the binding.

namespace_id: string

Namespace identifier tag.

maxLength32

type: "kv_namespace"

The kind of resource that the binding provides.

WorkersBindingKindMedia { name, type }

A JavaScript variable name for the binding.

type: "media"

The kind of resource that the binding provides.

WorkersBindingKindMTLSCertificate { certificate_id, name, type }

certificate_id: string

Identifier of the certificate to bind to.

A JavaScript variable name for the binding.

type: "mtls_certificate"

The kind of resource that the binding provides.

WorkersBindingKindPlainText { name, text, type }

A JavaScript variable name for the binding.

text: string

The text value to use.

type: "plain_text"

The kind of resource that the binding provides.

WorkersBindingKindPipelines { name, pipeline, type }

A JavaScript variable name for the binding.

pipeline: string

Name of the Pipeline to bind to.

type: "pipelines"

The kind of resource that the binding provides.

WorkersBindingKindK2 { name, stream, type }

A K2 stream binding. Available only to accounts enabled for K2.

A JavaScript variable name for the binding.

stream: string

ID of a K2 stream owned by the account deploying the Worker.

type: "k2"

The kind of resource that the binding provides.

WorkersBindingKindQueue { name, queue_name, type }

A JavaScript variable name for the binding.

queue_name: string

Name of the Queue to bind to.

type: "queue"

The kind of resource that the binding provides.

WorkersBindingKindRatelimit { name, namespace_id, simple, type }

A JavaScript variable name for the binding.

namespace_id: string

Identifier of the rate limit namespace to bind to.

simple: Simple { limit, period, mitigation_timeout }

The rate limit configuration.

limit: number

The limit (requests per period).

period: number

The period in seconds.

mitigation_timeout?: number