---
title: Scripts
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[Workers](https://developers.cloudflare.com/api/resources/workers)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Scripts
##### [List Worker Scripts](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/methods/list)
GET/accounts/{account\_id}/workers/scripts
##### [Search Worker Scripts](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/methods/search)
GET/accounts/{account\_id}/workers/scripts-search
##### [Download Worker Script](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/methods/get)
GET/accounts/{account\_id}/workers/scripts/{script\_name}
##### [Upload Worker Module](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/methods/update)
PUT/accounts/{account\_id}/workers/scripts/{script\_name}
##### [Delete Worker](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/methods/delete)
DELETE/accounts/{account\_id}/workers/scripts/{script\_name}
##### ModelsExpand Collapse
Script object {id, cache\_options, compatibility\_date, 20 more }
id: optional string
The name used to identify the script.
Link to this property
cache\_options: optional object {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.
Link to this property
cross\_version\_cache: optional 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.
Link to this property
Link to this property
compatibility\_date: optional string
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
Link to this property
compatibility\_flags: optional array of 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.
Link to this property
created\_on: optional string
When the script was created.
formatdate-time
Link to this property
etag: optional string
Hashed script content, can be used in a If-None-Match header when updating.
Link to this property
exports: optional map\[object {type, cache, state } or object {storage, type, container, state } or object {state, type } or 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:
Worker object {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.
Link to this property
cache: optional object {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.
Link to this property
Link to this property
state: optional "created"
Live export. May be omitted; defaults to created.
Link to this property
Link to this property
WorkersDurableObjectExport object {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"or "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"
Link to this property
"legacy-kv"
Link to this property
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
container: optional 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
Link to this property
state: optional "created"
Live export. May be omitted; defaults to created.
Link to this property
Link to this property
WorkersDurableObjectDeletedExport object {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.
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
Link to this property
WorkersDurableObjectRenamedExport object {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
Link to this property
state: "renamed"
Tombstone that renames the namespace’s class.
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
Link to this property
WorkersDurableObjectTransferredExport object {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.
Link to this property
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
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
Link to this property
WorkersDurableObjectExpectingTransferExport object {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.
Link to this property
storage: "sqlite"or "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"
Link to this property
"legacy-kv"
Link to this property
Link to this property
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
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
container: optional 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
Link to this property
Link to this property
Link to this property
handlers: optional array of string
The names of handlers exported as part of the default export.
Link to this property
has\_assets: optional boolean
Whether a Worker contains assets.
Link to this property
has\_modules: optional boolean
Whether a Worker contains modules.
Link to this property
last\_deployed\_from: optional string
The client most recently used to deploy this Worker.
Link to this property
logpush: optional boolean
Whether Logpush is turned on for the Worker.
Link to this property
migration\_tag: optional string
The tag of the Durable Object migration that was most recently applied for this Worker.
Link to this property
modified\_on: optional string
When the script was last modified.
formatdate-time
Link to this property
named\_handlers: optional array of object {handlers, name }
Named exports, such as Durable Object class implementations and named entrypoints.
handlers: optional array of string
The names of handlers exported as part of the named export.
Link to this property
name: optional string
The name of the export.
Link to this property
Link to this property
observability: optional object {enabled, head\_sampling\_rate, issues, 3 more }
Observability settings for the Worker.
enabled: boolean
Whether observability is enabled for the Worker.
Link to this property
head\_sampling\_rate: optional number
The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
Link to this property
issues: optional object {enabled }
Real-time Issues settings for the Worker.
enabled: optional boolean
Whether real-time Issues are enabled for the Worker.
Link to this property
Link to this property
logs: optional object {enabled, invocation\_logs, destinations, 2 more }
Log settings for the Worker.
enabled: boolean
Whether logs are enabled for the Worker.
Link to this property
invocation\_logs: boolean
Whether invocation logs are enabled for the Worker.
Link to this property
destinations: optional array of string
A list of destinations where logs will be exported to.
Link to this property
head\_sampling\_rate: optional number
The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
Link to this property
persist: optional boolean
Whether log persistence is enabled for the Worker.
Link to this property
Link to this property
redact\_query\_string: optional boolean
Whether query strings are removed from request URLs in logs and traces.
Link to this property
traces: optional object {destinations, enabled, head\_sampling\_rate, 2 more }
Trace settings for the Worker.
destinations: optional array of string
A list of destinations where traces will be exported to.
Link to this property
enabled: optional boolean
Whether traces are enabled for the Worker.
Link to this property
head\_sampling\_rate: optional number
The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
Link to this property
persist: optional boolean
Whether trace persistence is enabled for the Worker.
Link to this property
propagation\_policy: optional "authenticated"or "accept"
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"
Link to this property
"accept"
Link to this property
Link to this property
Link to this property
Link to this property
placement: optional object {mode, last\_analyzed\_at, status } or object {region, last\_analyzed\_at, status } or object {hostname, last\_analyzed\_at, status } or 5 more
Configuration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host.
One of the following:
object {mode, last\_analyzed\_at, status }
mode: "smart"
Enables Smart Placement.
Link to this property
last\_analyzed\_at: optional string
The last time the script was analyzed for Smart Placement.
formatdate-time
Link to this property
status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
Link to this property
object {region, last\_analyzed\_at, status }
region: string
Cloud region for targeted placement in format ‘provider:region’.
Link to this property
last\_analyzed\_at: optional string
The last time the script was analyzed for Smart Placement.
formatdate-time
Link to this property
status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
Link to this property
object {hostname, last\_analyzed\_at, status }
hostname: string
HTTP hostname for targeted placement.
Link to this property
last\_analyzed\_at: optional string
The last time the script was analyzed for Smart Placement.
formatdate-time
Link to this property
status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
Link to this property
object {host, last\_analyzed\_at, status }
host: string
TCP host and port for targeted placement.
Link to this property
last\_analyzed\_at: optional string
The last time the script was analyzed for Smart Placement.
formatdate-time
Link to this property
status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
Link to this property
object {mode, region, last\_analyzed\_at, status }
mode: "targeted"
Targeted placement mode.
Link to this property
region: string
Cloud region for targeted placement in format ‘provider:region’.
Link to this property
last\_analyzed\_at: optional string
The last time the script was analyzed for Smart Placement.
formatdate-time
Link to this property
status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
Link to this property
object {hostname, mode, last\_analyzed\_at, status }
hostname: string
HTTP hostname for targeted placement.
Link to this property
mode: "targeted"
Targeted placement mode.
Link to this property
last\_analyzed\_at: optional string
The last time the script was analyzed for Smart Placement.
formatdate-time
Link to this property
status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
Link to this property
object {host, mode, last\_analyzed\_at, status }
host: string
TCP host and port for targeted placement.
Link to this property
mode: "targeted"
Targeted placement mode.
Link to this property
last\_analyzed\_at: optional string
The last time the script was analyzed for Smart Placement.
formatdate-time
Link to this property
status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
Link to this property
object {mode, target, last\_analyzed\_at, status }
mode: "targeted"
Targeted placement mode.
Link to this property
target: array of object {region } or object {hostname } or object {host }
Array of placement targets (currently limited to single target).
One of the following:
Region object {region }
region: string
Cloud region in format ‘provider:region’.
Link to this property
Link to this property
Hostname object {hostname }
hostname: string
HTTP hostname for targeted placement.
Link to this property
Link to this property
Host object {host }
host: string
TCP host:port for targeted placement.
Link to this property
Link to this property
Link to this property
last\_analyzed\_at: optional string
The last time the script was analyzed for Smart Placement.
formatdate-time
Link to this property
status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
Link to this property
Link to this property
Deprecatedplacement\_mode: optional "smart"or "targeted"
Configuration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host.
One of the following:
"smart"
Link to this property
"targeted"
Link to this property
Link to this property
Deprecatedplacement\_status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
tag: optional string
The immutable ID of the script.
Link to this property
tags: optional array of string
Tags associated with the Worker.
Link to this property
tail\_consumers: optional array of ConsumerScript { service, environment, namespace }
List of Workers that will consume logs from the attached Worker.
service: string
Name of Worker that is to be the consumer.
Link to this property
environment: optional string
Optional environment if the Worker utilizes one.
Link to this property
namespace: optional string
Optional dispatch namespace the script belongs to.
Link to this property
Link to this property
usage\_model: optional "standard"or "bundled"or "unbound"
Usage model for the Worker invocations.
One of the following:
"standard"
Link to this property
"bundled"
Link to this property
"unbound"
Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts%20%3E%20(model)%20script%20%3E%20(schema)>)
ScriptSetting object {logpush, observability, tags, tail\_consumers }
logpush: optional boolean
Whether Logpush is turned on for the Worker.
Link to this property
observability: optional object {enabled, head\_sampling\_rate, issues, 3 more }
Observability settings for the Worker.
enabled: boolean
Whether observability is enabled for the Worker.
Link to this property
head\_sampling\_rate: optional number
The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
Link to this property
issues: optional object {enabled }
Real-time Issues settings for the Worker.
enabled: optional boolean
Whether real-time Issues are enabled for the Worker.
Link to this property
Link to this property
logs: optional object {enabled, invocation\_logs, destinations, 2 more }
Log settings for the Worker.
enabled: boolean
Whether logs are enabled for the Worker.
Link to this property
invocation\_logs: boolean
Whether invocation logs are enabled for the Worker.
Link to this property
destinations: optional array of string
A list of destinations where logs will be exported to.
Link to this property
head\_sampling\_rate: optional number
The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
Link to this property
persist: optional boolean
Whether log persistence is enabled for the Worker.
Link to this property
Link to this property
redact\_query\_string: optional boolean
Whether query strings are removed from request URLs in logs and traces.
Link to this property
traces: optional object {destinations, enabled, head\_sampling\_rate, 2 more }
Trace settings for the Worker.
destinations: optional array of string
A list of destinations where traces will be exported to.
Link to this property
enabled: optional boolean
Whether traces are enabled for the Worker.
Link to this property
head\_sampling\_rate: optional number
The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
Link to this property
persist: optional boolean
Whether trace persistence is enabled for the Worker.
Link to this property
propagation\_policy: optional "authenticated"or "accept"
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"
Link to this property
"accept"
Link to this property
Link to this property
Link to this property
Link to this property
tags: optional array of string
Tags associated with the Worker.
Link to this property
tail\_consumers: optional array of ConsumerScript { service, environment, namespace }
List of Workers that will consume logs from the attached Worker.
service: string
Name of Worker that is to be the consumer.
Link to this property
environment: optional string
Optional environment if the Worker utilizes one.
Link to this property
namespace: optional string
Optional dispatch namespace the script belongs to.
Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts%20%3E%20(model)%20script_setting%20%3E%20(schema)>)
ScriptListResponse object {id, cache\_options, compatibility\_date, 21 more }
id: optional string
The name used to identify the script.
Link to this property
cache\_options: optional object {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.
Link to this property
cross\_version\_cache: optional 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.
Link to this property
Link to this property
compatibility\_date: optional string
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
Link to this property
compatibility\_flags: optional array of 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.
Link to this property
created\_on: optional string
When the script was created.
formatdate-time
Link to this property
etag: optional string
Hashed script content, can be used in a If-None-Match header when updating.
Link to this property
exports: optional map\[object {type, cache, state } or object {storage, type, container, state } or object {state, type } or 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:
Worker object {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.
Link to this property
cache: optional object {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.
Link to this property
Link to this property
state: optional "created"
Live export. May be omitted; defaults to created.
Link to this property
Link to this property
WorkersDurableObjectExport object {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"or "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"
Link to this property
"legacy-kv"
Link to this property
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
container: optional 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
Link to this property
state: optional "created"
Live export. May be omitted; defaults to created.
Link to this property
Link to this property
WorkersDurableObjectDeletedExport object {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.
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
Link to this property
WorkersDurableObjectRenamedExport object {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
Link to this property
state: "renamed"
Tombstone that renames the namespace’s class.
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
Link to this property
WorkersDurableObjectTransferredExport object {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.
Link to this property
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
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
Link to this property
WorkersDurableObjectExpectingTransferExport object {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.
Link to this property
storage: "sqlite"or "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"
Link to this property
"legacy-kv"
Link to this property
Link to this property
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
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
container: optional 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
Link to this property
Link to this property
Link to this property
handlers: optional array of string
The names of handlers exported as part of the default export.
Link to this property
has\_assets: optional boolean
Whether a Worker contains assets.
Link to this property
has\_modules: optional boolean
Whether a Worker contains modules.
Link to this property
last\_deployed\_from: optional string
The client most recently used to deploy this Worker.
Link to this property
logpush: optional boolean
Whether Logpush is turned on for the Worker.
Link to this property
migration\_tag: optional string
The tag of the Durable Object migration that was most recently applied for this Worker.
Link to this property
modified\_on: optional string
When the script was last modified.
formatdate-time
Link to this property
named\_handlers: optional array of object {handlers, name }
Named exports, such as Durable Object class implementations and named entrypoints.
handlers: optional array of string
The names of handlers exported as part of the named export.
Link to this property
name: optional string
The name of the export.
Link to this property
Link to this property
observability: optional object {enabled, head\_sampling\_rate, issues, 3 more }
Observability settings for the Worker.
enabled: boolean
Whether observability is enabled for the Worker.
Link to this property
head\_sampling\_rate: optional number
The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
Link to this property
issues: optional object {enabled }
Real-time Issues settings for the Worker.
enabled: optional boolean
Whether real-time Issues are enabled for the Worker.
Link to this property
Link to this property
logs: optional object {enabled, invocation\_logs, destinations, 2 more }
Log settings for the Worker.
enabled: boolean
Whether logs are enabled for the Worker.
Link to this property
invocation\_logs: boolean
Whether invocation logs are enabled for the Worker.
Link to this property
destinations: optional array of string
A list of destinations where logs will be exported to.
Link to this property
head\_sampling\_rate: optional number
The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
Link to this property
persist: optional boolean
Whether log persistence is enabled for the Worker.
Link to this property
Link to this property
redact\_query\_string: optional boolean
Whether query strings are removed from request URLs in logs and traces.
Link to this property
traces: optional object {destinations, enabled, head\_sampling\_rate, 2 more }
Trace settings for the Worker.
destinations: optional array of string
A list of destinations where traces will be exported to.
Link to this property
enabled: optional boolean
Whether traces are enabled for the Worker.
Link to this property
head\_sampling\_rate: optional number
The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
Link to this property
persist: optional boolean
Whether trace persistence is enabled for the Worker.
Link to this property
propagation\_policy: optional "authenticated"or "accept"
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"
Link to this property
"accept"
Link to this property
Link to this property
Link to this property
Link to this property
placement: optional object {mode, last\_analyzed\_at, status } or object {region, last\_analyzed\_at, status } or object {hostname, last\_analyzed\_at, status } or 5 more
Configuration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host.
One of the following:
object {mode, last\_analyzed\_at, status }
mode: "smart"
Enables Smart Placement.
Link to this property
last\_analyzed\_at: optional string
The last time the script was analyzed for Smart Placement.
formatdate-time
Link to this property
status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
Link to this property
object {region, last\_analyzed\_at, status }
region: string
Cloud region for targeted placement in format ‘provider:region’.
Link to this property
last\_analyzed\_at: optional string
The last time the script was analyzed for Smart Placement.
formatdate-time
Link to this property
status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
Link to this property
object {hostname, last\_analyzed\_at, status }
hostname: string
HTTP hostname for targeted placement.
Link to this property
last\_analyzed\_at: optional string
The last time the script was analyzed for Smart Placement.
formatdate-time
Link to this property
status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
Link to this property
object {host, last\_analyzed\_at, status }
host: string
TCP host and port for targeted placement.
Link to this property
last\_analyzed\_at: optional string
The last time the script was analyzed for Smart Placement.
formatdate-time
Link to this property
status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
Link to this property
object {mode, region, last\_analyzed\_at, status }
mode: "targeted"
Targeted placement mode.
Link to this property
region: string
Cloud region for targeted placement in format ‘provider:region’.
Link to this property
last\_analyzed\_at: optional string
The last time the script was analyzed for Smart Placement.
formatdate-time
Link to this property
status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
Link to this property
object {hostname, mode, last\_analyzed\_at, status }
hostname: string
HTTP hostname for targeted placement.
Link to this property
mode: "targeted"
Targeted placement mode.
Link to this property
last\_analyzed\_at: optional string
The last time the script was analyzed for Smart Placement.
formatdate-time
Link to this property
status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
Link to this property
object {host, mode, last\_analyzed\_at, status }
host: string
TCP host and port for targeted placement.
Link to this property
mode: "targeted"
Targeted placement mode.
Link to this property
last\_analyzed\_at: optional string
The last time the script was analyzed for Smart Placement.
formatdate-time
Link to this property
status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
Link to this property
object {mode, target, last\_analyzed\_at, status }
mode: "targeted"
Targeted placement mode.
Link to this property
target: array of object {region } or object {hostname } or object {host }
Array of placement targets (currently limited to single target).
One of the following:
Region object {region }
region: string
Cloud region in format ‘provider:region’.
Link to this property
Link to this property
Hostname object {hostname }
hostname: string
HTTP hostname for targeted placement.
Link to this property
Link to this property
Host object {host }
host: string
TCP host:port for targeted placement.
Link to this property
Link to this property
Link to this property
last\_analyzed\_at: optional string
The last time the script was analyzed for Smart Placement.
formatdate-time
Link to this property
status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
Link to this property
Link to this property
Deprecatedplacement\_mode: optional "smart"or "targeted"
One of the following:
"smart"
Link to this property
"targeted"
Link to this property
Link to this property
Deprecatedplacement\_status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
routes: optional array of object {id, pattern, script }
Routes associated with the Worker.
id: string
Identifier.
maxLength32
Link to this property
pattern: string
Pattern to match incoming requests against. Learn more.
Link to this property
script: optional string
Name of the script to run if the route matches.
Link to this property
Link to this property
tag: optional string
The immutable ID of the script.
Link to this property
tags: optional array of string
Tags associated with the Worker.
Link to this property
tail\_consumers: optional array of ConsumerScript { service, environment, namespace }
List of Workers that will consume logs from the attached Worker.
service: string
Name of Worker that is to be the consumer.
Link to this property
environment: optional string
Optional environment if the Worker utilizes one.
Link to this property
namespace: optional string
Optional dispatch namespace the script belongs to.
Link to this property
Link to this property
usage\_model: optional "standard"or "bundled"or "unbound"
Usage model for the Worker invocations.
One of the following:
"standard"
Link to this property
"bundled"
Link to this property
"unbound"
Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts%20%3E%20(model)%20script_list_response%20%3E%20(schema)>)
ScriptSearchResponse = array of object {id, created\_on, modified\_on, 4 more }
id: string
Identifier.
maxLength32
Link to this property
created\_on: string
When the script was created.
formatdate-time
Link to this property
modified\_on: string
When the script was last modified.
formatdate-time
Link to this property
script\_name: string
Name of the script.
Link to this property
environment\_is\_default: optional boolean
Whether the environment is the default environment.
Link to this property
environment\_name: optional string
Name of the environment.
Link to this property
service\_name: optional string
Name of the service.
Link to this property
[Link to this property](<#(resource)%20workers.scripts%20%3E%20(model)%20script_search_response%20%3E%20(schema)>)
ScriptGetResponse = string
[Link to this property](<#(resource)%20workers.scripts%20%3E%20(model)%20script_get_response%20%3E%20(schema)>)
ScriptUpdateResponse object {startup\_time\_ms, id, cache\_options, 22 more }
startup\_time\_ms: number
Link to this property
id: optional string
The name used to identify the script.
Link to this property
cache\_options: optional object {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.
Link to this property
cross\_version\_cache: optional 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.
Link to this property
Link to this property
compatibility\_date: optional string
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
Link to this property
compatibility\_flags: optional array of 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.
Link to this property
created\_on: optional string
When the script was created.
formatdate-time
Link to this property
entry\_point: optional string
The entry point for the script.
Link to this property
etag: optional string
Hashed script content, can be used in a If-None-Match header when updating.
Link to this property
exports: optional map\[object {type, cache, state } or object {storage, type, container, state } or object {state, type } or 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:
Worker object {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.
Link to this property
cache: optional object {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.
Link to this property
Link to this property
state: optional "created"
Live export. May be omitted; defaults to created.
Link to this property
Link to this property
WorkersDurableObjectExport object {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"or "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"
Link to this property
"legacy-kv"
Link to this property
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
container: optional 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
Link to this property
state: optional "created"
Live export. May be omitted; defaults to created.
Link to this property
Link to this property
WorkersDurableObjectDeletedExport object {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.
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
Link to this property
WorkersDurableObjectRenamedExport object {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
Link to this property
state: "renamed"
Tombstone that renames the namespace’s class.
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
Link to this property
WorkersDurableObjectTransferredExport object {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.
Link to this property
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
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
Link to this property
WorkersDurableObjectExpectingTransferExport object {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.
Link to this property
storage: "sqlite"or "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"
Link to this property
"legacy-kv"
Link to this property
Link to this property
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
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
container: optional 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
Link to this property
Link to this property
Link to this property
handlers: optional array of string
The names of handlers exported as part of the default export.
Link to this property
has\_assets: optional boolean
Whether a Worker contains assets.
Link to this property
has\_modules: optional boolean
Whether a Worker contains modules.
Link to this property
last\_deployed\_from: optional string
The client most recently used to deploy this Worker.
Link to this property
logpush: optional boolean
Whether Logpush is turned on for the Worker.
Link to this property
migration\_tag: optional string
The tag of the Durable Object migration that was most recently applied for this Worker.
Link to this property
modified\_on: optional string
When the script was last modified.
formatdate-time
Link to this property
named\_handlers: optional array of object {handlers, name }
Named exports, such as Durable Object class implementations and named entrypoints.
handlers: optional array of string
The names of handlers exported as part of the named export.
Link to this property
name: optional string
The name of the export.
Link to this property
Link to this property
observability: optional object {enabled, head\_sampling\_rate, issues, 3 more }
Observability settings for the Worker.
enabled: boolean
Whether observability is enabled for the Worker.
Link to this property
head\_sampling\_rate: optional number
The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
Link to this property
issues: optional object {enabled }
Real-time Issues settings for the Worker.
enabled: optional boolean
Whether real-time Issues are enabled for the Worker.
Link to this property
Link to this property
logs: optional object {enabled, invocation\_logs, destinations, 2 more }
Log settings for the Worker.
enabled: boolean
Whether logs are enabled for the Worker.
Link to this property
invocation\_logs: boolean
Whether invocation logs are enabled for the Worker.
Link to this property
destinations: optional array of string
A list of destinations where logs will be exported to.
Link to this property
head\_sampling\_rate: optional number
The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
Link to this property
persist: optional boolean
Whether log persistence is enabled for the Worker.
Link to this property
Link to this property
redact\_query\_string: optional boolean
Whether query strings are removed from request URLs in logs and traces.
Link to this property
traces: optional object {destinations, enabled, head\_sampling\_rate, 2 more }
Trace settings for the Worker.
destinations: optional array of string
A list of destinations where traces will be exported to.
Link to this property
enabled: optional boolean
Whether traces are enabled for the Worker.
Link to this property
head\_sampling\_rate: optional number
The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
Link to this property
persist: optional boolean
Whether trace persistence is enabled for the Worker.
Link to this property
propagation\_policy: optional "authenticated"or "accept"
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"
Link to this property
"accept"
Link to this property
Link to this property
Link to this property
Link to this property
placement: optional object {mode, last\_analyzed\_at, status } or object {region, last\_analyzed\_at, status } or object {hostname, last\_analyzed\_at, status } or 5 more
Configuration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host.
One of the following:
object {mode, last\_analyzed\_at, status }
mode: "smart"
Enables Smart Placement.
Link to this property
last\_analyzed\_at: optional string
The last time the script was analyzed for Smart Placement.
formatdate-time
Link to this property
status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
Link to this property
object {region, last\_analyzed\_at, status }
region: string
Cloud region for targeted placement in format ‘provider:region’.
Link to this property
last\_analyzed\_at: optional string
The last time the script was analyzed for Smart Placement.
formatdate-time
Link to this property
status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
Link to this property
object {hostname, last\_analyzed\_at, status }
hostname: string
HTTP hostname for targeted placement.
Link to this property
last\_analyzed\_at: optional string
The last time the script was analyzed for Smart Placement.
formatdate-time
Link to this property
status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
Link to this property
object {host, last\_analyzed\_at, status }
host: string
TCP host and port for targeted placement.
Link to this property
last\_analyzed\_at: optional string
The last time the script was analyzed for Smart Placement.
formatdate-time
Link to this property
status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
Link to this property
object {mode, region, last\_analyzed\_at, status }
mode: "targeted"
Targeted placement mode.
Link to this property
region: string
Cloud region for targeted placement in format ‘provider:region’.
Link to this property
last\_analyzed\_at: optional string
The last time the script was analyzed for Smart Placement.
formatdate-time
Link to this property
status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
Link to this property
object {hostname, mode, last\_analyzed\_at, status }
hostname: string
HTTP hostname for targeted placement.
Link to this property
mode: "targeted"
Targeted placement mode.
Link to this property
last\_analyzed\_at: optional string
The last time the script was analyzed for Smart Placement.
formatdate-time
Link to this property
status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
Link to this property
object {host, mode, last\_analyzed\_at, status }
host: string
TCP host and port for targeted placement.
Link to this property
mode: "targeted"
Targeted placement mode.
Link to this property
last\_analyzed\_at: optional string
The last time the script was analyzed for Smart Placement.
formatdate-time
Link to this property
status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
Link to this property
object {mode, target, last\_analyzed\_at, status }
mode: "targeted"
Targeted placement mode.
Link to this property
target: array of object {region } or object {hostname } or object {host }
Array of placement targets (currently limited to single target).
One of the following:
Region object {region }
region: string
Cloud region in format ‘provider:region’.
Link to this property
Link to this property
Hostname object {hostname }
hostname: string
HTTP hostname for targeted placement.
Link to this property
Link to this property
Host object {host }
host: string
TCP host:port for targeted placement.
Link to this property
Link to this property
Link to this property
last\_analyzed\_at: optional string
The last time the script was analyzed for Smart Placement.
formatdate-time
Link to this property
status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
Status of Smart Placement.
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
Link to this property
Link to this property
Deprecatedplacement\_mode: optional "smart"or "targeted"
One of the following:
"smart"
Link to this property
"targeted"
Link to this property
Link to this property
Deprecatedplacement\_status: optional "SUCCESS"or "UNSUPPORTED\_APPLICATION"or "INSUFFICIENT\_INVOCATIONS"
One of the following:
"SUCCESS"
Link to this property
"UNSUPPORTED\_APPLICATION"
Link to this property
"INSUFFICIENT\_INVOCATIONS"
Link to this property
Link to this property
tag: optional string
The immutable ID of the script.
Link to this property
tags: optional array of string
Tags associated with the Worker.
Link to this property
tail\_consumers: optional array of ConsumerScript { service, environment, namespace }
List of Workers that will consume logs from the attached Worker.
service: string
Name of Worker that is to be the consumer.
Link to this property
environment: optional string
Optional environment if the Worker utilizes one.
Link to this property
namespace: optional string
Optional dispatch namespace the script belongs to.
Link to this property
Link to this property
usage\_model: optional "standard"or "bundled"or "unbound"
Usage model for the Worker invocations.
One of the following:
"standard"
Link to this property
"bundled"
Link to this property
"unbound"
Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts%20%3E%20(model)%20script_update_response%20%3E%20(schema)>)
ScriptDeleteResponse = unknown
[Link to this property](<#(resource)%20workers.scripts%20%3E%20(model)%20script_delete_response%20%3E%20(schema)>)
#### ScriptsAssets
#### ScriptsAssetsUpload
##### [Create Worker Assets Upload Session](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/assets/subresources/upload/methods/create)
POST/accounts/{account\_id}/workers/scripts/{script\_name}/assets-upload-session
##### ModelsExpand Collapse
UploadCreateResponse object {buckets, jwt }
buckets: optional array of array of string
The requests to make to upload assets.
Link to this property
jwt: optional string
A JWT to use as authentication for uploading assets.
Link to this property
[Link to this property](<#(resource)%20workers.scripts.assets.upload%20%3E%20(model)%20upload_create_response%20%3E%20(schema)>)
#### ScriptsSubdomain
##### [Get Worker Script Subdomain](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/subdomain/methods/get)
GET/accounts/{account\_id}/workers/scripts/{script\_name}/subdomain
##### [Update Worker Script Subdomain](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/subdomain/methods/create)
POST/accounts/{account\_id}/workers/scripts/{script\_name}/subdomain
##### [Delete Worker Script Subdomain](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/subdomain/methods/delete)
DELETE/accounts/{account\_id}/workers/scripts/{script\_name}/subdomain
##### ModelsExpand Collapse
SubdomainGetResponse object {enabled, previews\_enabled }
enabled: boolean
Whether the Worker is available on the workers.dev subdomain.
Link to this property
previews\_enabled: boolean
Whether the Worker’s Preview URLs are available on the workers.dev subdomain.
Link to this property
[Link to this property](<#(resource)%20workers.scripts.subdomain%20%3E%20(model)%20subdomain_get_response%20%3E%20(schema)>)
SubdomainCreateResponse object {enabled, previews\_enabled }
enabled: boolean
Whether the Worker is available on the workers.dev subdomain.
Link to this property
previews\_enabled: boolean
Whether the Worker’s Preview URLs are available on the workers.dev subdomain.
Link to this property
[Link to this property](<#(resource)%20workers.scripts.subdomain%20%3E%20(model)%20subdomain_create_response%20%3E%20(schema)>)
SubdomainDeleteResponse object {enabled, previews\_enabled }
enabled: boolean
Whether the Worker is available on the workers.dev subdomain.
Link to this property
previews\_enabled: boolean
Whether the Worker’s Preview URLs are available on the workers.dev subdomain.
Link to this property
[Link to this property](<#(resource)%20workers.scripts.subdomain%20%3E%20(model)%20subdomain_delete_response%20%3E%20(schema)>)
#### ScriptsSchedules
##### [Get Worker Script Schedules (Cron Triggers)](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/schedules/methods/get)
GET/accounts/{account\_id}/workers/scripts/{script\_name}/schedules
##### [Update Worker Script Schedules (Cron Triggers)](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/schedules/methods/update)
PUT/accounts/{account\_id}/workers/scripts/{script\_name}/schedules
##### ModelsExpand Collapse
ScheduleGetResponse object {schedules }
schedules: array of object {cron, created\_on, modified\_on }
cron: string
Link to this property
created\_on: optional string
Link to this property
modified\_on: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts.schedules%20%3E%20(model)%20schedule_get_response%20%3E%20(schema)>)
ScheduleUpdateResponse object {schedules }
schedules: array of object {cron, created\_on, modified\_on }
cron: string
Link to this property
created\_on: optional string
Link to this property
modified\_on: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts.schedules%20%3E%20(model)%20schedule_update_response%20%3E%20(schema)>)
#### ScriptsTail
##### [List Worker Tails](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/tail/methods/get)
GET/accounts/{account\_id}/workers/scripts/{script\_name}/tails
##### [Start Worker Tail](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/tail/methods/create)
POST/accounts/{account\_id}/workers/scripts/{script\_name}/tails
##### [Delete Worker Tail](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/tail/methods/delete)
DELETE/accounts/{account\_id}/workers/scripts/{script\_name}/tails/{id}
##### ModelsExpand Collapse
ConsumerScript object {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.
Link to this property
environment: optional string
Optional environment if the Worker utilizes one.
Link to this property
namespace: optional string
Optional dispatch namespace the script belongs to.
Link to this property
[Link to this property](<#(resource)%20workers.scripts.tail%20%3E%20(model)%20consumer_script%20%3E%20(schema)>)
TailGetResponse object {id, expires\_at, url }
id: string
Identifier.
maxLength32
Link to this property
expires\_at: string
Link to this property
url: string
Link to this property
[Link to this property](<#(resource)%20workers.scripts.tail%20%3E%20(model)%20tail_get_response%20%3E%20(schema)>)
TailCreateResponse object {id, expires\_at, url }
id: string
Identifier.
maxLength32
Link to this property
expires\_at: string
Link to this property
url: string
Link to this property
[Link to this property](<#(resource)%20workers.scripts.tail%20%3E%20(model)%20tail_create_response%20%3E%20(schema)>)
TailDeleteResponse object {errors, messages, success }
errors: array of object {code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
Link to this property
messages: array of object {code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
Link to this property
success: true
Whether the API call was successful.
Link to this property
[Link to this property](<#(resource)%20workers.scripts.tail%20%3E%20(model)%20tail_delete_response%20%3E%20(schema)>)
#### ScriptsContent
##### [Get Worker Script Content](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/content/methods/get)
GET/accounts/{account\_id}/workers/scripts/{script\_name}/content/v2
##### [Replace Worker Script Content](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/content/methods/update)
PUT/accounts/{account\_id}/workers/scripts/{script\_name}/content
#### ScriptsSettings
##### [Get Worker Script Settings](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/settings/methods/get)
GET/accounts/{account\_id}/workers/scripts/{script\_name}/script-settings
##### [Patch Worker Script Settings](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/settings/methods/edit)
PATCH/accounts/{account\_id}/workers/scripts/{script\_name}/script-settings
#### ScriptsDeployments
##### [List Worker Deployments](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/deployments/methods/list)
GET/accounts/{account\_id}/workers/scripts/{script\_name}/deployments
##### [Create Worker Deployment](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/deployments/methods/create)
POST/accounts/{account\_id}/workers/scripts/{script\_name}/deployments
##### [Get Worker Deployment](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/deployments/methods/get)
GET/accounts/{account\_id}/workers/scripts/{script\_name}/deployments/{deployment\_id}
##### [Delete Worker Deployment](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/deployments/methods/delete)
DELETE/accounts/{account\_id}/workers/scripts/{script\_name}/deployments/{deployment\_id}
##### ModelsExpand Collapse
Deployment object {id, created\_on, source, 4 more }
id: string
formatuuid
Link to this property
created\_on: string
formatdate-time
Link to this property
source: string
Link to this property
strategy: "percentage"
Link to this property
versions: array of object {percentage, version\_id }
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
Link to this property
version\_id: string
Identifier of the Worker Version.
formatuuid
Link to this property
Link to this property
annotations: optional object {"workers/message", "workers/triggered\_by" }
"workers/message": optional string
Human-readable message about the deployment. Truncated to 1000 bytes if longer.
maxLength1000
Link to this property
"workers/triggered\_by": optional string
Operation that triggered the creation of the deployment.
Link to this property
Link to this property
author\_email: optional string
formatemail
Link to this property
[Link to this property](<#(resource)%20workers.scripts.deployments%20%3E%20(model)%20deployment%20%3E%20(schema)>)
DeploymentListResponse object {deployments }
deployments: array of Deployment { id, created\_on, source, 4 more }
id: string
formatuuid
Link to this property
created\_on: string
formatdate-time
Link to this property
source: string
Link to this property
strategy: "percentage"
Link to this property
versions: array of object {percentage, version\_id }
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
Link to this property
version\_id: string
Identifier of the Worker Version.
formatuuid
Link to this property
Link to this property
annotations: optional object {"workers/message", "workers/triggered\_by" }
"workers/message": optional string
Human-readable message about the deployment. Truncated to 1000 bytes if longer.
maxLength1000
Link to this property
"workers/triggered\_by": optional string
Operation that triggered the creation of the deployment.
Link to this property
Link to this property
author\_email: optional string
formatemail
Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts.deployments%20%3E%20(model)%20deployment_list_response%20%3E%20(schema)>)
DeploymentDeleteResponse object {errors, messages, success }
errors: array of object {code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
Link to this property
messages: array of object {code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
Link to this property
success: true
Whether the API call was successful.
Link to this property
[Link to this property](<#(resource)%20workers.scripts.deployments%20%3E%20(model)%20deployment_delete_response%20%3E%20(schema)>)
#### ScriptsVersions
##### [List Versions](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/versions/methods/list)
GET/accounts/{account\_id}/workers/scripts/{script\_name}/versions
##### [Get Worker Script Version](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/versions/methods/get)
GET/accounts/{account\_id}/workers/scripts/{script\_name}/versions/{version\_id}
##### [Upload Version](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/versions/methods/create)
POST/accounts/{account\_id}/workers/scripts/{script\_name}/versions
##### ModelsExpand Collapse
VersionListResponse object {id, metadata, number }
id: optional string
Unique identifier for the version.
Link to this property
metadata: optional object {author\_email, author\_id, created\_on, 3 more }
author\_email: optional string
Email of the user who created the version.
Link to this property
author\_id: optional string
Identifier of the user who created the version.
Link to this property
created\_on: optional string
When the version was created.
Link to this property
hasPreview: optional boolean
Whether the version can be previewed.
Link to this property
modified\_on: optional string
When the version was last modified.
Link to this property
source: optional "unknown"or "api"or "wrangler"or 8 more
The source of the version upload.
One of the following:
"unknown"
Link to this property
"api"
Link to this property
"wrangler"
Link to this property
"terraform"
Link to this property
"dash"
Link to this property
"cf\_cli"
Link to this property
"dash\_template"
Link to this property
"integration"
Link to this property
"quick\_editor"
Link to this property
"playground"
Link to this property
"workersci"
Link to this property
Link to this property
Link to this property
number: optional number
Sequential version number.
Link to this property
[Link to this property](<#(resource)%20workers.scripts.versions%20%3E%20(model)%20version_list_response%20%3E%20(schema)>)
VersionGetResponse object {resources, id, metadata, number }
resources: object {bindings, script, script\_runtime }
bindings: optional
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.
Link to this property
script: optional object {etag, handlers, last\_deployed\_from, named\_handlers }
etag: optional string
Hashed script content
Link to this property
handlers: optional array of string
The names of handlers exported as part of the default export.
Link to this property
last\_deployed\_from: optional string
The client most recently used to deploy this Worker.
Link to this property
named\_handlers: optional array of object {handlers, name }
Named exports, such as Durable Object class implementations and named entrypoints.
handlers: optional array of string
The names of handlers exported as part of the named export.
Link to this property
name: optional string
The name of the exported class or entrypoint.
Link to this property
Link to this property
Link to this property
script\_runtime: optional object {compatibility\_date, compatibility\_flags, exports, 3 more }
Runtime configuration for the Worker.
compatibility\_date: optional string
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
Link to this property
compatibility\_flags: optional array of string
Flags that enable or disable certain features in the Workers runtime.
Link to this property
exports: optional map\[object {type, cache, state } or object {storage, type, container, state } or object {state, type } or 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:
Worker object {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.
Link to this property
cache: optional object {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.
Link to this property
Link to this property
state: optional "created"
Live export. May be omitted; defaults to created.
Link to this property
Link to this property
WorkersDurableObjectExport object {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"or "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"
Link to this property
"legacy-kv"
Link to this property
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
container: optional 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
Link to this property
state: optional "created"
Live export. May be omitted; defaults to created.
Link to this property
Link to this property
WorkersDurableObjectDeletedExport object {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.
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
Link to this property
WorkersDurableObjectRenamedExport object {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
Link to this property
state: "renamed"
Tombstone that renames the namespace’s class.
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
Link to this property
WorkersDurableObjectTransferredExport object {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.
Link to this property
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
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
Link to this property
WorkersDurableObjectExpectingTransferExport object {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.
Link to this property
storage: "sqlite"or "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"
Link to this property
"legacy-kv"
Link to this property
Link to this property
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
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
container: optional 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
Link to this property
Link to this property
Link to this property
limits: optional object {cpu\_ms }
Resource limits for the Worker.
cpu\_ms: optional number
The amount of CPU time this Worker can use in milliseconds.
Link to this property
Link to this property
migration\_tag: optional string
The tag of the Durable Object migration that was most recently applied for this Worker.
Link to this property
usage\_model: optional "bundled"or "unbound"or "standard"
Usage model for the Worker invocations.
One of the following:
"bundled"
Link to this property
"unbound"
Link to this property
"standard"
Link to this property
Link to this property
Link to this property
Link to this property
id: optional string
Unique identifier for the version.
Link to this property
metadata: optional object {author\_email, author\_id, created\_on, 3 more }
author\_email: optional string
Email of the user who created the version.
Link to this property
author\_id: optional string
Identifier of the user who created the version.
Link to this property
created\_on: optional string
When the version was created.
Link to this property
hasPreview: optional boolean
Whether the version can be previewed.
Link to this property
modified\_on: optional string
When the version was last modified.
Link to this property
source: optional "unknown"or "api"or "wrangler"or 8 more
The source of the version upload.
One of the following:
"unknown"
Link to this property
"api"
Link to this property
"wrangler"
Link to this property
"terraform"
Link to this property
"dash"
Link to this property
"cf\_cli"
Link to this property
"dash\_template"
Link to this property
"integration"
Link to this property
"quick\_editor"
Link to this property
"playground"
Link to this property
"workersci"
Link to this property
Link to this property
Link to this property
number: optional number
Sequential version number.
Link to this property
[Link to this property](<#(resource)%20workers.scripts.versions%20%3E%20(model)%20version_get_response%20%3E%20(schema)>)
VersionCreateResponse object {resources, id, exports\_reconciliation, 3 more }
resources: object {bindings, script, script\_runtime }
bindings: optional
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.
Link to this property
script: optional object {etag, handlers, last\_deployed\_from, named\_handlers }
etag: optional string
Hashed script content
Link to this property
handlers: optional array of string
The names of handlers exported as part of the default export.
Link to this property
last\_deployed\_from: optional string
The client most recently used to deploy this Worker.
Link to this property
named\_handlers: optional array of object {handlers, name }
Named exports, such as Durable Object class implementations and named entrypoints.
handlers: optional array of string
The names of handlers exported as part of the named export.
Link to this property
name: optional string
The name of the exported class or entrypoint.
Link to this property
Link to this property
Link to this property
script\_runtime: optional object {compatibility\_date, compatibility\_flags, exports, 3 more }
Runtime configuration for the Worker.
compatibility\_date: optional string
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
Link to this property
compatibility\_flags: optional array of string
Flags that enable or disable certain features in the Workers runtime.
Link to this property
exports: optional map\[object {type, cache, state } or object {storage, type, container, state } or object {state, type } or 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:
Worker object {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.
Link to this property
cache: optional object {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.
Link to this property
Link to this property
state: optional "created"
Live export. May be omitted; defaults to created.
Link to this property
Link to this property
WorkersDurableObjectExport object {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"or "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"
Link to this property
"legacy-kv"
Link to this property
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
container: optional 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
Link to this property
state: optional "created"
Live export. May be omitted; defaults to created.
Link to this property
Link to this property
WorkersDurableObjectDeletedExport object {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.
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
Link to this property
WorkersDurableObjectRenamedExport object {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
Link to this property
state: "renamed"
Tombstone that renames the namespace’s class.
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
Link to this property
WorkersDurableObjectTransferredExport object {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.
Link to this property
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
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
Link to this property
WorkersDurableObjectExpectingTransferExport object {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.
Link to this property
storage: "sqlite"or "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"
Link to this property
"legacy-kv"
Link to this property
Link to this property
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
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
container: optional 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
Link to this property
Link to this property
Link to this property
limits: optional object {cpu\_ms }
Resource limits for the Worker.
cpu\_ms: optional number
The amount of CPU time this Worker can use in milliseconds.
Link to this property
Link to this property
migration\_tag: optional string
The tag of the Durable Object migration that was most recently applied for this Worker.
Link to this property
usage\_model: optional "bundled"or "unbound"or "standard"
Usage model for the Worker invocations.
One of the following:
"bundled"
Link to this property
"unbound"
Link to this property
"standard"
Link to this property
Link to this property
Link to this property
Link to this property
id: optional string
Unique identifier for the version.
Link to this property
exports\_reconciliation: optional object {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 of string
Class names for which a new namespace was provisioned.
Link to this property
deleted: array of string
Class names whose namespace was deleted by a deleted tombstone.
Link to this property
info: array of object {class, message, scenario, 2 more }
Non-blocking info entries (stale tombstones, tombstone applied with class still in code). See exports_reconciliation_info.
class: string
The class name the info entry is about.
Link to this property
message: string
Human-readable explanation.
Link to this property
scenario: "code\_class\_not\_in\_exports"or "provisioned\_class\_missing\_from\_config"or "config\_export\_not\_in\_code"or 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"
Link to this property
"provisioned\_class\_missing\_from\_config"
Link to this property
"config\_export\_not\_in\_code"
Link to this property
"config\_references\_nonexistent\_class"
Link to this property
"orphaned\_provisioned\_namespace"
Link to this property
"storage\_type\_mismatch"
Link to this property
"free\_tier\_requires\_sqlite"
Link to this property
"invalid\_export"
Link to this property
"tombstone\_delete\_class\_still\_in\_code"
Link to this property
"tombstone\_delete\_blocked\_by\_external\_bindings"
Link to this property
"tombstone\_renamed\_to\_occupied"
Link to this property
"transferred\_pending\_not\_found"
Link to this property
"transferred\_target\_missing"
Link to this property
"transferred\_target\_mismatch"
Link to this property
"phase\_one\_transfer\_source\_missing"
Link to this property
"phase\_one\_transfer\_source\_namespace\_missing"
Link to this property
"phase\_one\_transfer\_target\_class\_provisioned"
Link to this property
"phase\_one\_transfer\_after\_commit\_mismatch"
Link to this property
"phase\_one\_transfer\_duplicate"
Link to this property
"phase\_one\_transfer\_target\_in\_dispatch\_namespace"
Link to this property
"phase\_one\_transfer\_source\_in\_dispatch\_namespace"
Link to this property
"transferred\_source\_in\_dispatch\_namespace"
Link to this property
"transferred\_target\_in\_dispatch\_namespace"
Link to this property
"container\_undeclared\_reference"
Link to this property
"container\_class\_not\_durable\_object"
Link to this property
"container\_wiring\_inconsistent"
Link to this property
"container\_multiple\_durable\_objects"
Link to this property
"transfer\_container\_parity\_mismatch"
Link to this property
"transfer\_container\_parity\_mismatch\_on\_commit"
Link to this property
"tombstone\_class\_still\_in\_code"
Link to this property
"stale\_tombstone"
Link to this property
"transfer\_receive\_already\_applied"
Link to this property
"transfer\_receive\_cleanup\_complete"
Link to this property
Link to this property
namespace\_id: optional string
The provisioned namespace the entry relates to, when applicable.
formatuuid
Link to this property
referencing\_scripts: optional array of 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.
Link to this property
Link to this property
removable\_entries: array of string
Source class names whose tombstone entry is now stale and safe to delete from exports (no remaining referencing scripts).
Link to this property
renamed: array of object {from, to }
Applied renamed tombstones.
from: string
The original (source) class name.
Link to this property
to: string
The new class name (renamed_to).
Link to this property
Link to this property
transfer\_pending: array of object {class, from }
Phase-1 transfer hints recorded on the target side.
class: string
The target-side class name awaiting transfer.
Link to this property
from: string
The source script the namespace will be transferred from.
Link to this property
Link to this property
transferred: array of object {class, phase, to }
Committed transferred tombstones (phase-2).
class: string
The source class name that was transferred.
Link to this property
phase: "committed"
The transfer phase. Currently always committed.
Link to this property
to: string
The destination script that now owns the namespace.
Link to this property
Link to this property
updated: array of string
Class names whose provisioned namespace was mutated in place.
Link to this property
warnings: array of object {class, message, scenario, namespace\_id }
Non-blocking warnings. See exports_reconciliation_warning.
class: string
The class name the warning is about.
Link to this property
message: string
Human-readable explanation of the warning.
Link to this property
scenario: "code\_class\_not\_in\_exports"or "provisioned\_class\_missing\_from\_config"or "config\_export\_not\_in\_code"or 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"
Link to this property
"provisioned\_class\_missing\_from\_config"
Link to this property
"config\_export\_not\_in\_code"
Link to this property
"config\_references\_nonexistent\_class"
Link to this property
"orphaned\_provisioned\_namespace"
Link to this property
"storage\_type\_mismatch"
Link to this property
"free\_tier\_requires\_sqlite"
Link to this property
"invalid\_export"
Link to this property
"tombstone\_delete\_class\_still\_in\_code"
Link to this property
"tombstone\_delete\_blocked\_by\_external\_bindings"
Link to this property
"tombstone\_renamed\_to\_occupied"
Link to this property
"transferred\_pending\_not\_found"
Link to this property
"transferred\_target\_missing"
Link to this property
"transferred\_target\_mismatch"
Link to this property
"phase\_one\_transfer\_source\_missing"
Link to this property
"phase\_one\_transfer\_source\_namespace\_missing"
Link to this property
"phase\_one\_transfer\_target\_class\_provisioned"
Link to this property
"phase\_one\_transfer\_after\_commit\_mismatch"
Link to this property
"phase\_one\_transfer\_duplicate"
Link to this property
"phase\_one\_transfer\_target\_in\_dispatch\_namespace"
Link to this property
"phase\_one\_transfer\_source\_in\_dispatch\_namespace"
Link to this property
"transferred\_source\_in\_dispatch\_namespace"
Link to this property
"transferred\_target\_in\_dispatch\_namespace"
Link to this property
"container\_undeclared\_reference"
Link to this property
"container\_class\_not\_durable\_object"
Link to this property
"container\_wiring\_inconsistent"
Link to this property
"container\_multiple\_durable\_objects"
Link to this property
"transfer\_container\_parity\_mismatch"
Link to this property
"transfer\_container\_parity\_mismatch\_on\_commit"
Link to this property
"tombstone\_class\_still\_in\_code"
Link to this property
"stale\_tombstone"
Link to this property
"transfer\_receive\_already\_applied"
Link to this property
"transfer\_receive\_cleanup\_complete"
Link to this property
Link to this property
namespace\_id: optional string
The provisioned namespace the warning relates to, when applicable.
formatuuid
Link to this property
Link to this property
Link to this property
metadata: optional object {author\_email, author\_id, created\_on, 3 more }
author\_email: optional string
Email of the user who created the version.
Link to this property
author\_id: optional string
Identifier of the user who created the version.
Link to this property
created\_on: optional string
When the version was created.
Link to this property
hasPreview: optional boolean
Whether the version can be previewed.
Link to this property
modified\_on: optional string
When the version was last modified.
Link to this property
source: optional "unknown"or "api"or "wrangler"or 8 more
The source of the version upload.
One of the following:
"unknown"
Link to this property
"api"
Link to this property
"wrangler"
Link to this property
"terraform"
Link to this property
"dash"
Link to this property
"cf\_cli"
Link to this property
"dash\_template"
Link to this property
"integration"
Link to this property
"quick\_editor"
Link to this property
"playground"
Link to this property
"workersci"
Link to this property
Link to this property
Link to this property
number: optional number
Sequential version number.
Link to this property
startup\_time\_ms: optional number
Time in milliseconds spent on Worker startup.
Link to this property
[Link to this property](<#(resource)%20workers.scripts.versions%20%3E%20(model)%20version_create_response%20%3E%20(schema)>)
#### ScriptsSecrets
##### [List secrets bound to a Worker script](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/secrets/methods/list)
GET/accounts/{account\_id}/workers/scripts/{script\_name}/secrets
##### [Get a secret binding](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/secrets/methods/get)
GET/accounts/{account\_id}/workers/scripts/{script\_name}/secrets/{secret\_name}
##### [Add a secret to a Worker script](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/secrets/methods/update)
PUT/accounts/{account\_id}/workers/scripts/{script\_name}/secrets
##### [Delete Worker script secret](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/secrets/methods/delete)
DELETE/accounts/{account\_id}/workers/scripts/{script\_name}/secrets/{secret\_name}
##### [Patch multiple Worker script secrets](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/secrets/methods/bulk_update)
PATCH/accounts/{account\_id}/workers/scripts/{script\_name}/secrets-bulk
##### ModelsExpand Collapse
SecretListResponse = object {name, text, type } or object {algorithm, format, name, 4 more }
A secret value accessible through a binding.
One of the following:
SecretText object {name, text, type }
name: string
A JavaScript variable name for the binding.
Link to this property
text: string
The secret value to use.
Link to this property
type: "secret\_text"
The kind of resource that the binding provides.
Link to this property
Link to this property
SecretKey object {algorithm, format, name, 4 more }
algorithm: unknown
Algorithm-specific key parameters. Learn more.
Link to this property
format: "raw"or "pkcs8"or "spki"or "jwk"
Data format of the key. Learn more.
One of the following:
"raw"
Link to this property
"pkcs8"
Link to this property
"spki"
Link to this property
"jwk"
Link to this property
Link to this property
name: string
A JavaScript variable name for the binding.
Link to this property
type: "secret\_key"
The kind of resource that the binding provides.
Link to this property
usages: array of "encrypt"or "decrypt"or "sign"or 5 more
Allowed operations with the key. Learn more.
One of the following:
"encrypt"
Link to this property
"decrypt"
Link to this property
"sign"
Link to this property
"verify"
Link to this property
"deriveKey"
Link to this property
"deriveBits"
Link to this property
"wrapKey"
Link to this property
"unwrapKey"
Link to this property
Link to this property
key\_base64: optional string
Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”.
Link to this property
key\_jwk: optional unknown
Key data in JSON Web Key format. Required if format is “jwk”.
Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts.secrets%20%3E%20(model)%20secret_list_response%20%3E%20(schema)>)
SecretGetResponse = object {name, text, type } or object {algorithm, format, name, 4 more }
A secret value accessible through a binding.
One of the following:
SecretText object {name, text, type }
name: string
A JavaScript variable name for the binding.
Link to this property
text: string
The secret value to use.
Link to this property
type: "secret\_text"
The kind of resource that the binding provides.
Link to this property
Link to this property
SecretKey object {algorithm, format, name, 4 more }
algorithm: unknown
Algorithm-specific key parameters. Learn more.
Link to this property
format: "raw"or "pkcs8"or "spki"or "jwk"
Data format of the key. Learn more.
One of the following:
"raw"
Link to this property
"pkcs8"
Link to this property
"spki"
Link to this property
"jwk"
Link to this property
Link to this property
name: string
A JavaScript variable name for the binding.
Link to this property
type: "secret\_key"
The kind of resource that the binding provides.
Link to this property
usages: array of "encrypt"or "decrypt"or "sign"or 5 more
Allowed operations with the key. Learn more.
One of the following:
"encrypt"
Link to this property
"decrypt"
Link to this property
"sign"
Link to this property
"verify"
Link to this property
"deriveKey"
Link to this property
"deriveBits"
Link to this property
"wrapKey"
Link to this property
"unwrapKey"
Link to this property
Link to this property
key\_base64: optional string
Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”.
Link to this property
key\_jwk: optional unknown
Key data in JSON Web Key format. Required if format is “jwk”.
Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts.secrets%20%3E%20(model)%20secret_get_response%20%3E%20(schema)>)
SecretUpdateResponse = object {name, text, type } or object {algorithm, format, name, 4 more }
A secret value accessible through a binding.
One of the following:
SecretText object {name, text, type }
name: string
A JavaScript variable name for the binding.
Link to this property
text: string
The secret value to use.
Link to this property
type: "secret\_text"
The kind of resource that the binding provides.
Link to this property
Link to this property
SecretKey object {algorithm, format, name, 4 more }
algorithm: unknown
Algorithm-specific key parameters. Learn more.
Link to this property
format: "raw"or "pkcs8"or "spki"or "jwk"
Data format of the key. Learn more.
One of the following:
"raw"
Link to this property
"pkcs8"
Link to this property
"spki"
Link to this property
"jwk"
Link to this property
Link to this property
name: string
A JavaScript variable name for the binding.
Link to this property
type: "secret\_key"
The kind of resource that the binding provides.
Link to this property
usages: array of "encrypt"or "decrypt"or "sign"or 5 more
Allowed operations with the key. Learn more.
One of the following:
"encrypt"
Link to this property
"decrypt"
Link to this property
"sign"
Link to this property
"verify"
Link to this property
"deriveKey"
Link to this property
"deriveBits"
Link to this property
"wrapKey"
Link to this property
"unwrapKey"
Link to this property
Link to this property
key\_base64: optional string
Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”.
Link to this property
key\_jwk: optional unknown
Key data in JSON Web Key format. Required if format is “jwk”.
Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts.secrets%20%3E%20(model)%20secret_update_response%20%3E%20(schema)>)
SecretDeleteResponse = unknown
[Link to this property](<#(resource)%20workers.scripts.secrets%20%3E%20(model)%20secret_delete_response%20%3E%20(schema)>)
SecretBulkUpdateResponse = map\[object {name, text, type } or object {algorithm, format, name, 4 more } ]
Map of secret names to secret metadata for resulting secrets.
One of the following:
SecretText object {name, text, type }
name: string
A JavaScript variable name for the binding.
Link to this property
text: string
The secret value to use.
Link to this property
type: "secret\_text"
The kind of resource that the binding provides.
Link to this property
Link to this property
SecretKey object {algorithm, format, name, 4 more }
algorithm: unknown
Algorithm-specific key parameters. Learn more.
Link to this property
format: "raw"or "pkcs8"or "spki"or "jwk"
Data format of the key. Learn more.
One of the following:
"raw"
Link to this property
"pkcs8"
Link to this property
"spki"
Link to this property
"jwk"
Link to this property
Link to this property
name: string
A JavaScript variable name for the binding.
Link to this property
type: "secret\_key"
The kind of resource that the binding provides.
Link to this property
usages: array of "encrypt"or "decrypt"or "sign"or 5 more
Allowed operations with the key. Learn more.
One of the following:
"encrypt"
Link to this property
"decrypt"
Link to this property
"sign"
Link to this property
"verify"
Link to this property
"deriveKey"
Link to this property
"deriveBits"
Link to this property
"wrapKey"
Link to this property
"unwrapKey"
Link to this property
Link to this property
key\_base64: optional string
Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”.
Link to this property
key\_jwk: optional unknown
Key data in JSON Web Key format. Required if format is “jwk”.
Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts.secrets%20%3E%20(model)%20secret_bulk_update_response%20%3E%20(schema)>)
#### ScriptsScript And Version Settings
##### [Get Worker Script and Version Settings](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/script_and_version_settings/methods/get)
GET/accounts/{account\_id}/workers/scripts/{script\_name}/settings
##### [Patch Worker Script and Version Settings](https://developers.cloudflare.com/api/resources/workers/subresources/scripts/subresources/script_and_version_settings/methods/edit)
PATCH/accounts/{account\_id}/workers/scripts/{script\_name}/settings
##### ModelsExpand Collapse
ScriptAndVersionSettingGetResponse object {annotations, bindings, cache\_options, 12 more }
annotations: optional object {"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": optional string
Human-readable message about the version. Truncated to 1000 bytes if longer.
maxLength1000
Link to this property
"workers/tag": optional string
User-provided identifier for the version. Maximum 100 bytes.
maxLength100
Link to this property
"workers/triggered\_by": optional string
Operation that triggered the creation of the version. This is read-only and set by the server.
Link to this property
Link to this property
bindings: optional array of object {name, type } or object {instance\_name, name, type, namespace } or object {name, namespace, type } or 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:
AI object {name, type }
name: string
A JavaScript variable name for the binding.
Link to this property
type: "ai"
The kind of resource that the binding provides.
Link to this property
Link to this property
AISearch object {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.
Link to this property
name: string
A JavaScript variable name for the binding.
Link to this property
type: "ai\_search"
The kind of resource that the binding provides.
Link to this property
namespace: optional string
The namespace the instance belongs to. Defaults to “default” if omitted. Customers who don’t use namespaces can simply omit this field.
Link to this property
Link to this property
AISearchNamespace object {name, namespace, type }
name: string
A JavaScript variable name for the binding.
Link to this property
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.
Link to this property
type: "ai\_search\_namespace"
The kind of resource that the binding provides.
Link to this property
Link to this property
Messaging object {name, namespace, type }
name: string
A JavaScript variable name for the binding.
Link to this property
namespace: string
The Messaging namespace to bind to.
Link to this property
type: "messaging"
The kind of resource that the binding provides.
Link to this property
Link to this property
AnalyticsEngine object {dataset, name, type }
dataset: string
The name of the dataset to bind to.
Link to this property
name: string
A JavaScript variable name for the binding.
Link to this property
type: "analytics\_engine"
The kind of resource that the binding provides.
Link to this property
Link to this property
Artifacts object {name, namespace, type }
name: string
A JavaScript variable name for the binding.
Link to this property
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
Link to this property
type: "artifacts"
The kind of resource that the binding provides.
Link to this property
Link to this property
Assets object {name, type }
name: string
A JavaScript variable name for the binding.
Link to this property
type: "assets"
The kind of resource that the binding provides.
Link to this property
Link to this property
Browser object {name, type }
name: string
A JavaScript variable name for the binding.
Link to this property
type: "browser"
The kind of resource that the binding provides.
Link to this property
Link to this property
D1 object {database\_id, name, type, id }
database\_id: string
Identifier of the D1 database to bind to.
Link to this property
name: string
A JavaScript variable name for the binding.
Link to this property
type: "d1"
The kind of resource that the binding provides.
Link to this property
Deprecatedid: optional string
This property has been renamed to database_id.
Identifier of the D1 database to bind to.
Link to this property
Link to this property
DataBlob object {name, part, type }
name: string
A JavaScript variable name for the binding.
Link to this property
part: string
The name of the file containing the data content. Only accepted for service worker syntax Workers.
Link to this property
Deprecatedtype: "data\_blob"
The kind of resource that the binding provides.
Link to this property
Link to this property
DispatchNamespace object {name, namespace, type, outbound }
name: string
A JavaScript variable name for the binding.
Link to this property
namespace: string
The name of the dispatch namespace.
Link to this property
type: "dispatch\_namespace"
The kind of resource that the binding provides.
Link to this property
outbound: optional object {params, worker }
Outbound worker.
params: optional array of object {name }
Pass information from the Dispatch Worker to the Outbound Worker through the parameters.
name: string
Name of the parameter.
Link to this property
Link to this property
worker: optional object {entrypoint, environment, service }
Outbound worker.
entrypoint: optional string
Entrypoint to invoke on the outbound worker.
Link to this property
environment: optional string
Environment of the outbound worker.
Link to this property
service: optional string
Name of the outbound worker.
Link to this property
Link to this property
Link to this property
Link to this property
DurableObjectNamespace object {name, type, class\_name, 4 more }
name: string
A JavaScript variable name for the binding.
Link to this property
type: "durable\_object\_namespace"
The kind of resource that the binding provides.
Link to this property
class\_name: optional string
The exported class name of the Durable Object.
Link to this property
dispatch\_namespace: optional string
The dispatch namespace the Durable Object script belongs to.
Link to this property
environment: optional string
The environment of the script\_name to bind to.
Link to this property
namespace\_id: optional string
Namespace identifier tag.
maxLength32
Link to this property
script\_name: optional string
The script where the Durable Object is defined, if it is external to this Worker.
Link to this property
Link to this property
Hyperdrive object {id, name, type }
id: string
Identifier of the Hyperdrive connection to bind to.
Link to this property
name: string
A JavaScript variable name for the binding.
Link to this property
type: "hyperdrive"
The kind of resource that the binding provides.
Link to this property
Link to this property
Inherit object {name, type, old\_name, version\_id }
name: string
The name of the inherited binding.
Link to this property
type: "inherit"
The kind of resource that the binding provides.
Link to this property
old\_name: optional 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.
Link to this property
version\_id: optional 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.
Link to this property
Link to this property
Images object {name, type }
name: string
A JavaScript variable name for the binding.
Link to this property
type: "images"
The kind of resource that the binding provides.
Link to this property
Link to this property
Json object {json, name, type }
json: unknown
JSON data to use.
Link to this property
name: string
A JavaScript variable name for the binding.
Link to this property
type: "json"
The kind of resource that the binding provides.
Link to this property
Link to this property
KVNamespace object {name, namespace\_id, type }
name: string
A JavaScript variable name for the binding.
Link to this property
namespace\_id: string
Namespace identifier tag.
maxLength32
Link to this property
type: "kv\_namespace"
The kind of resource that the binding provides.
Link to this property
Link to this property
Media object {name, type }
name: string
A JavaScript variable name for the binding.
Link to this property
type: "media"
The kind of resource that the binding provides.
Link to this property
Link to this property
MTLSCertificate object {certificate\_id, name, type }
certificate\_id: string
Identifier of the certificate to bind to.
Link to this property
name: string
A JavaScript variable name for the binding.
Link to this property
type: "mtls\_certificate"
The kind of resource that the binding provides.
Link to this property
Link to this property
PlainText object {name, text, type }
name: string
A JavaScript variable name for the binding.
Link to this property
text: string
The text value to use.
Link to this property
type: "plain\_text"
The kind of resource that the binding provides.
Link to this property
Link to this property
Pipelines object {name, pipeline, type }
name: string
A JavaScript variable name for the binding.
Link to this property
pipeline: string
Name of the Pipeline to bind to.
Link to this property
type: "pipelines"
The kind of resource that the binding provides.
Link to this property
Link to this property
K2 object {name, stream, type }
A K2 stream binding. Available only to accounts enabled for K2.
name: string
A JavaScript variable name for the binding.
Link to this property
stream: string
ID of a K2 stream owned by the account deploying the Worker.
Link to this property
type: "k2"
The kind of resource that the binding provides.
Link to this property
Link to this property
Queue object {name, queue\_name, type }
name: string
A JavaScript variable name for the binding.
Link to this property
queue\_name: string
Name of the Queue to bind to.
Link to this property
type: "queue"
The kind of resource that the binding provides.
Link to this property
Link to this property
Ratelimit object {name, namespace\_id, simple, type }
name: string
A JavaScript variable name for the binding.
Link to this property
namespace\_id: string
Identifier of the rate limit namespace to bind to.
Link to this property
simple: object {limit, period, mitigation\_timeout }
The rate limit configuration.
limit: number
The limit (requests per period).
Link to this property
period: number
The period in seconds.
Link to this property
mitigation\_timeout: optional 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.
Link to this property
Link to this property
type: "ratelimit"
The kind of resource that the binding provides.
Link to this property
Link to this property
R2Bucket object {bucket\_name, name, type, jurisdiction }
bucket\_name: string
R2 bucket to bind to.
Link to this property
name: string
A JavaScript variable name for the binding.
Link to this property
type: "r2\_bucket"
The kind of resource that the binding provides.
Link to this property
jurisdiction: optional "eu"or "fedramp"or "fedramp-high"or "us"
The jurisdiction of the R2 bucket.
One of the following:
"eu"
Link to this property
"fedramp"
Link to this property
"fedramp-high"
Link to this property
"us"
Link to this property
Link to this property
Link to this property
SecretText object {name, text, type }
name: string
A JavaScript variable name for the binding.
Link to this property
text: string
The secret value to use.
Link to this property
type: "secret\_text"
The kind of resource that the binding provides.
Link to this property
Link to this property
SendEmail object {name, type, allowed\_destination\_addresses, 2 more }
name: string
A JavaScript variable name for the binding.
Link to this property
type: "send\_email"
The kind of resource that the binding provides.
Link to this property
allowed\_destination\_addresses: optional array of string
List of allowed destination addresses.
Link to this property
allowed\_sender\_addresses: optional array of string
List of allowed sender addresses.
Link to this property
destination\_address: optional string
Destination address for the email.
formatemail
Link to this property
Link to this property
Service object {name, service, type, 2 more }
name: string
A JavaScript variable name for the binding.
Link to this property
service: string
Name of Worker to bind to.
Link to this property
type: "service"
The kind of resource that the binding provides.
Link to this property
entrypoint: optional string
Entrypoint to invoke on the target Worker.
Link to this property
environment: optional string
Optional environment if the Worker utilizes one.
Link to this property
Link to this property
TextBlob object {name, part, type }
name: string
A JavaScript variable name for the binding.
Link to this property
part: string
The name of the file containing the text content. Only accepted for service worker syntax Workers.
Link to this property
Deprecatedtype: "text\_blob"
The kind of resource that the binding provides.
Link to this property
Link to this property
Vectorize object {index\_name, name, type }
index\_name: string
Name of the Vectorize index to bind to.
Link to this property
name: string
A JavaScript variable name for the binding.
Link to this property
type: "vectorize"
The kind of resource that the binding provides.
Link to this property
Link to this property
VersionMetadata object {name, type }
name: string
A JavaScript variable name for the binding.
Link to this property
type: "version\_metadata"
The kind of resource that the binding provides.
Link to this property
Link to this property
SecretsStoreSecret object {name, secret\_name, store\_id, type }
name: string
A JavaScript variable name for the binding.
Link to this property
secret\_name: string
Name of the secret in the store.
Link to this property
store\_id: string
ID of the store containing the secret.
Link to this property
type: "secrets\_store\_secret"
The kind of resource that the binding provides.
Link to this property
Link to this property
Flagship object {app\_id, name, type }
app\_id: string
ID of the Flagship app to bind to for feature flag evaluation.
maxLength128
Link to this property
name: string
A JavaScript variable name for the binding.
Link to this property
type: "flagship"
The kind of resource that the binding provides.
Link to this property
Link to this property
SecretKey object {algorithm, format, name, 4 more }
algorithm: unknown
Algorithm-specific key parameters. Learn more.
Link to this property
format: "raw"or "pkcs8"or "spki"or "jwk"
Data format of the key. Learn more.
One of the following:
"raw"
Link to this property
"pkcs8"
Link to this property
"spki"
Link to this property
"jwk"
Link to this property
Link to this property
name: string
A JavaScript variable name for the binding.
Link to this property
type: "secret\_key"
The kind of resource that the binding provides.
Link to this property
usages: array of "encrypt"or "decrypt"or "sign"or 5 more
Allowed operations with the key. Learn more.
One of the following:
"encrypt"
Link to this property
"decrypt"
Link to this property
"sign"
Link to this property
"verify"
Link to this property
"deriveKey"
Link to this property
"deriveBits"
Link to this property
"wrapKey"
Link to this property
"unwrapKey"
Link to this property
Link to this property
key\_base64: optional string
Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”.
Link to this property
key\_jwk: optional unknown
Key data in JSON Web Key format. Required if format is “jwk”.
Link to this property
Link to this property
Workflow object {name, type, workflow\_name, 2 more }
name: string
A JavaScript variable name for the binding.
Link to this property
type: "workflow"
The kind of resource that the binding provides.
Link to this property
workflow\_name: string
Name of the Workflow to bind to.
Link to this property
class\_name: optional string
Class name of the Workflow. Should only be provided if the Workflow belongs to this script.
Link to this property
script\_name: optional string
Script name that contains the Workflow. If not provided, defaults to this script name.
Link to this property
Link to this property
WasmModule object {name, part, type }
name: string
A JavaScript variable name for the binding.
Link to this property
part: string
The name of the file containing the WebAssembly module content. Only accepted for service worker syntax Workers.
Link to this property
Deprecatedtype: "wasm\_module"
The kind of resource that the binding provides.
Link to this property
Link to this property
VPCService object {name, service\_id, type }
name: string
A JavaScript variable name for the binding.
Link to this property
service\_id: string
Identifier of the VPC service to bind to.
Link to this property
type: "vpc\_service"
The kind of resource that the binding provides.
Link to this property
Link to this property
VPCNetwork object {name, type, identity, 2 more }
name: string
A JavaScript variable name for the binding.
Link to this property
type: "vpc\_network"
The kind of resource that the binding provides.
Link to this property
identity: optional "runtime-email-alpha"
Enables Gateway identity for the binding. Requires network\_id to be “cf1:network” and cannot be combined with tunnel\_id.
Link to this property
network\_id: optional string
Identifier of the network to bind to. Only “cf1:network” is currently supported. Mutually exclusive with tunnel\_id.
Link to this property
tunnel\_id: optional string
UUID of the Cloudflare Tunnel to bind to. Mutually exclusive with network\_id.
Link to this property
Link to this property
Link to this property
cache\_options: optional object {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.
Link to this property
cross\_version\_cache: optional 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.
Link to this property
Link to this property
compatibility\_date: optional string
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
Link to this property
compatibility\_flags: optional array of 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.
Link to this property
exports: optional map\[object {type, cache, state } or object {storage, type, container, state } or object {state, type } or 3 more]
Declarative exports for the Worker. Worker entrypoint entries (type: worker) carry cache configuration for that entrypoint.
One of the following:
Worker object {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.
Link to this property
cache: optional object {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.
Link to this property
Link to this property
state: optional "created"
Live export. May be omitted; defaults to created.
Link to this property
Link to this property
WorkersDurableObjectExport object {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"or "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"
Link to this property
"legacy-kv"
Link to this property
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
container: optional 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
Link to this property
state: optional "created"
Live export. May be omitted; defaults to created.
Link to this property
Link to this property
WorkersDurableObjectDeletedExport object {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.
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
Link to this property
WorkersDurableObjectRenamedExport object {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
Link to this property
state: "renamed"
Tombstone that renames the namespace’s class.
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
Link to this property
WorkersDurableObjectTransferredExport object {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.
Link to this property
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
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
Link to this property
WorkersDurableObjectExpectingTransferExport object {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.
Link to this property
storage: "sqlite"or "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"
Link to this property
"legacy-kv"
Link to this property
Link to this property
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
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
container: optional 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
Link to this property
Link to this property
Link to this property
exports\_reconciliation: optional object {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 of string
Class names for which a new namespace was provisioned.
Link to this property
deleted: array of string
Class names whose namespace was deleted by a deleted tombstone.
Link to this property
info: array of object {class, message, scenario, 2 more }
Non-blocking info entries (stale tombstones, tombstone applied with class still in code). See exports_reconciliation_info.
class: string
The class name the info entry is about.
Link to this property
message: string
Human-readable explanation.
Link to this property
scenario: "code\_class\_not\_in\_exports"or "provisioned\_class\_missing\_from\_config"or "config\_export\_not\_in\_code"or 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"
Link to this property
"provisioned\_class\_missing\_from\_config"
Link to this property
"config\_export\_not\_in\_code"
Link to this property
"config\_references\_nonexistent\_class"
Link to this property
"orphaned\_provisioned\_namespace"
Link to this property
"storage\_type\_mismatch"
Link to this property
"free\_tier\_requires\_sqlite"
Link to this property
"invalid\_export"
Link to this property
"tombstone\_delete\_class\_still\_in\_code"
Link to this property
"tombstone\_delete\_blocked\_by\_external\_bindings"
Link to this property
"tombstone\_renamed\_to\_occupied"
Link to this property
"transferred\_pending\_not\_found"
Link to this property
"transferred\_target\_missing"
Link to this property
"transferred\_target\_mismatch"
Link to this property
"phase\_one\_transfer\_source\_missing"
Link to this property
"phase\_one\_transfer\_source\_namespace\_missing"
Link to this property
"phase\_one\_transfer\_target\_class\_provisioned"
Link to this property
"phase\_one\_transfer\_after\_commit\_mismatch"
Link to this property
"phase\_one\_transfer\_duplicate"
Link to this property
"phase\_one\_transfer\_target\_in\_dispatch\_namespace"
Link to this property
"phase\_one\_transfer\_source\_in\_dispatch\_namespace"
Link to this property
"transferred\_source\_in\_dispatch\_namespace"
Link to this property
"transferred\_target\_in\_dispatch\_namespace"
Link to this property
"container\_undeclared\_reference"
Link to this property
"container\_class\_not\_durable\_object"
Link to this property
"container\_wiring\_inconsistent"
Link to this property
"container\_multiple\_durable\_objects"
Link to this property
"transfer\_container\_parity\_mismatch"
Link to this property
"transfer\_container\_parity\_mismatch\_on\_commit"
Link to this property
"tombstone\_class\_still\_in\_code"
Link to this property
"stale\_tombstone"
Link to this property
"transfer\_receive\_already\_applied"
Link to this property
"transfer\_receive\_cleanup\_complete"
Link to this property
Link to this property
namespace\_id: optional string
The provisioned namespace the entry relates to, when applicable.
formatuuid
Link to this property
referencing\_scripts: optional array of 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.
Link to this property
Link to this property
removable\_entries: array of string
Source class names whose tombstone entry is now stale and safe to delete from exports (no remaining referencing scripts).
Link to this property
renamed: array of object {from, to }
Applied renamed tombstones.
from: string
The original (source) class name.
Link to this property
to: string
The new class name (renamed_to).
Link to this property
Link to this property
transfer\_pending: array of object {class, from }
Phase-1 transfer hints recorded on the target side.
class: string
The target-side class name awaiting transfer.
Link to this property
from: string
The source script the namespace will be transferred from.
Link to this property
Link to this property
transferred: array of object {class, phase, to }
Committed transferred tombstones (phase-2).
class: string
The source class name that was transferred.
Link to this property
phase: "committed"
The transfer phase. Currently always committed.
Link to this property
to: string
The destination script that now owns the namespace.
Link to this property
Link to this property
updated: array of string
Class names whose provisioned namespace was mutated in place.
Link to this property
warnings: array of object {class, message, scenario, namespace\_id }
Non-blocking warnings. See exports_reconciliation_warning.
class: string
The class name the warning is about.
Link to this property
message: string
Human-readable explanation of the warning.
Link to this property
scenario: "code\_class\_not\_in\_exports"or "provisioned\_class\_missing\_from\_config"or "config\_export\_not\_in\_code"or 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"
Link to this property
"provisioned\_class\_missing\_from\_config"
Link to this property
"config\_export\_not\_in\_code"
Link to this property
"config\_references\_nonexistent\_class"
Link to this property
"orphaned\_provisioned\_namespace"
Link to this property
"storage\_type\_mismatch"
Link to this property
"free\_tier\_requires\_sqlite"
Link to this property
"invalid\_export"
Link to this property
"tombstone\_delete\_class\_still\_in\_code"
Link to this property
"tombstone\_delete\_blocked\_by\_external\_bindings"
Link to this property
"tombstone\_renamed\_to\_occupied"
Link to this property
"transferred\_pending\_not\_found"
Link to this property
"transferred\_target\_missing"
Link to this property
"transferred\_target\_mismatch"
Link to this property
"phase\_one\_transfer\_source\_missing"
Link to this property
"phase\_one\_transfer\_source\_namespace\_missing"
Link to this property
"phase\_one\_transfer\_target\_class\_provisioned"
Link to this property
"phase\_one\_transfer\_after\_commit\_mismatch"
Link to this property
"phase\_one\_transfer\_duplicate"
Link to this property
"phase\_one\_transfer\_target\_in\_dispatch\_namespace"
Link to this property
"phase\_one\_transfer\_source\_in\_dispatch\_namespace"
Link to this property
"transferred\_source\_in\_dispatch\_namespace"
Link to this property
"transferred\_target\_in\_dispatch\_namespace"
Link to this property
"container\_undeclared\_reference"
Link to this property
"container\_class\_not\_durable\_object"
Link to this property
"container\_wiring\_inconsistent"
Link to this property
"container\_multiple\_durable\_objects"
Link to this property
"transfer\_container\_parity\_mismatch"
Link to this property
"transfer\_container\_parity\_mismatch\_on\_commit"
Link to this property
"tombstone\_class\_still\_in\_code"
Link to this property
"stale\_tombstone"
Link to this property
"transfer\_receive\_already\_applied"
Link to this property
"transfer\_receive\_cleanup\_complete"
Link to this property
Link to this property
namespace\_id: optional string
The provisioned namespace the warning relates to, when applicable.
formatuuid
Link to this property
Link to this property
Link to this property
limits: optional object {cpu\_ms, subrequests }
Limits to apply for this Worker.
cpu\_ms: optional number
The amount of CPU time this Worker can use in milliseconds.
Link to this property
subrequests: optional number
The number of subrequests this Worker can make per request.
Link to this property
Link to this property
logpush: optional boolean
Whether Logpush is turned on for the Worker.
Link to this property
migrations: optional SingleStepMigration { deleted\_classes, new\_classes, new\_sqlite\_classes, 4 more } or object {new\_tag, old\_tag, steps }
Migrations to apply for Durable Objects associated with this Worker.
One of the following:
SingleStepMigration object {deleted\_classes, new\_classes, new\_sqlite\_classes, 4 more }
A single set of migrations to apply.
deleted\_classes: optional array of string
A list of classes to delete Durable Object namespaces from.
Link to this property
new\_classes: optional array of string
A list of classes to create Durable Object namespaces from.
Link to this property
new\_sqlite\_classes: optional array of string
A list of classes to create Durable Object namespaces with SQLite from.
Link to this property
new\_tag: optional string
Tag to set as the latest migration tag.
Link to this property
old\_tag: optional string
Tag used to verify against the latest migration tag for this Worker. If they don’t match, the upload is rejected.
Link to this property
renamed\_classes: optional array of object {from, to }
A list of classes with Durable Object namespaces that were renamed.
from: optional string
Link to this property
to: optional string
Link to this property
Link to this property
transferred\_classes: optional array of object {from, from\_script, to }
A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker.
from: optional string
Link to this property
from\_script: optional string
Link to this property
to: optional string
Link to this property
Link to this property
Link to this property
WorkersMultipleStepMigrations object {new\_tag, old\_tag, steps }
new\_tag: optional string
Tag to set as the latest migration tag.
Link to this property
old\_tag: optional string
Tag used to verify against the latest migration tag for this Worker. If they don’t match, the upload is rejected.
Link to this property
steps: optional array of MigrationStep { deleted\_classes, new\_classes, new\_sqlite\_classes, 2 more }
Migrations to apply in order.
deleted\_classes: optional array of string
A list of classes to delete Durable Object namespaces from.
Link to this property
new\_classes: optional array of string
A list of classes to create Durable Object namespaces from.
Link to this property
new\_sqlite\_classes: optional array of string
A list of classes to create Durable Object namespaces with SQLite from.
Link to this property
renamed\_classes: optional array of object {from, to }
A list of classes with Durable Object namespaces that were renamed.
from: optional string
Link to this property
to: optional string
Link to this property
Link to this property
transferred\_classes: optional array of object {from, from\_script, to }
A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker.
from: optional string
Link to this property
from\_script: optional string
Link to this property
to: optional string
Link to this property
Link to this property
Link to this property
Link to this property
Link to this property
observability: optional object {enabled, head\_sampling\_rate, issues, 3 more }
Observability settings for the Worker.
enabled: boolean
Whether observability is enabled for the Worker.
Link to this property
head\_sampling\_rate: optional number
The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
Link to this property
issues: optional object {enabled }
Real-time Issues settings for the Worker.
enabled: optional boolean
Whether real-time Issues are enabled for the Worker.
Link to this property
Link to this property
logs: optional object {enabled, invocation\_logs, destinations, 2 more }
Log settings for the Worker.
enabled: boolean
Whether logs are enabled for the Worker.
Link to this property
invocation\_logs: boolean
Whether invocation logs are enabled for the Worker.
Link to this property
destinations: optional array of string
A list of destinations where logs will be exported to.
Link to this property
head\_sampling\_rate: optional number
The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
Link to this property
persist: optional boolean
Whether log persistence is enabled for the Worker.
Link to this property
Link to this property
redact\_query\_string: optional boolean
Whether query strings are removed from request URLs in logs and traces.
Link to this property
traces: optional object {destinations, enabled, head\_sampling\_rate, 2 more }
Trace settings for the Worker.
destinations: optional array of string
A list of destinations where traces will be exported to.
Link to this property
enabled: optional boolean
Whether traces are enabled for the Worker.
Link to this property
head\_sampling\_rate: optional number
The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
Link to this property
persist: optional boolean
Whether trace persistence is enabled for the Worker.
Link to this property
propagation\_policy: optional "authenticated"or "accept"
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"
Link to this property
"accept"
Link to this property
Link to this property
Link to this property
Link to this property
placement: optional object {mode } or object {region } or object {hostname } or 5 more
Configuration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host.
One of the following:
Mode object {mode }
mode: "smart"
Enables Smart Placement.
Link to this property
Link to this property
Region object {region }
region: string
Cloud region for targeted placement in format ‘provider:region’.
Link to this property
Link to this property
Hostname object {hostname }
hostname: string
HTTP hostname for targeted placement.
Link to this property
Link to this property
Host object {host }
host: string
TCP host and port for targeted placement.
Link to this property
Link to this property
object {mode, region }
mode: "targeted"
Targeted placement mode.
Link to this property
region: string
Cloud region for targeted placement in format ‘provider:region’.
Link to this property
Link to this property
object {hostname, mode }
hostname: string
HTTP hostname for targeted placement.
Link to this property
mode: "targeted"
Targeted placement mode.
Link to this property
Link to this property
object {host, mode }
host: string
TCP host and port for targeted placement.
Link to this property
mode: "targeted"
Targeted placement mode.
Link to this property
Link to this property
object {mode, target }
mode: "targeted"
Targeted placement mode.
Link to this property
target: array of object {region } or object {hostname } or object {host }
Array of placement targets (currently limited to single target).
One of the following:
Region object {region }
region: string
Cloud region in format ‘provider:region’.
Link to this property
Link to this property
Hostname object {hostname }
hostname: string
HTTP hostname for targeted placement.
Link to this property
Link to this property
Host object {host }
host: string
TCP host:port for targeted placement.
Link to this property
Link to this property
Link to this property
Link to this property
Link to this property
tags: optional array of string
Tags associated with the Worker.
Link to this property
tail\_consumers: optional array of ConsumerScript { service, environment, namespace }
List of Workers that will consume logs from the attached Worker.
service: string
Name of Worker that is to be the consumer.
Link to this property
environment: optional string
Optional environment if the Worker utilizes one.
Link to this property
namespace: optional string
Optional dispatch namespace the script belongs to.
Link to this property
Link to this property
usage\_model: optional "standard"or "bundled"or "unbound"
Usage model for the Worker invocations.
One of the following:
"standard"
Link to this property
"bundled"
Link to this property
"unbound"
Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts.script_and_version_settings%20%3E%20(model)%20script_and_version_setting_get_response%20%3E%20(schema)>)
ScriptAndVersionSettingEditResponse object {annotations, bindings, cache\_options, 12 more }
annotations: optional object {"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": optional string
Human-readable message about the version. Truncated to 1000 bytes if longer.
maxLength1000
Link to this property
"workers/tag": optional string
User-provided identifier for the version. Maximum 100 bytes.
maxLength100
Link to this property
"workers/triggered\_by": optional string
Operation that triggered the creation of the version. This is read-only and set by the server.
Link to this property
Link to this property
bindings: optional array of object {name, type } or object {instance\_name, name, type, namespace } or object {name, namespace, type } or 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:
AI object {name, type }
name: string
A JavaScript variable name for the binding.
Link to this property
type: "ai"
The kind of resource that the binding provides.
Link to this property
Link to this property
AISearch object {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.
Link to this property
name: string
A JavaScript variable name for the binding.
Link to this property
type: "ai\_search"
The kind of resource that the binding provides.
Link to this property
namespace: optional string
The namespace the instance belongs to. Defaults to “default” if omitted. Customers who don’t use namespaces can simply omit this field.
Link to this property
Link to this property
AISearchNamespace object {name, namespace, type }
name: string
A JavaScript variable name for the binding.
Link to this property
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.
Link to this property
type: "ai\_search\_namespace"
The kind of resource that the binding provides.
Link to this property
Link to this property
Messaging object {name, namespace, type }
name: string
A JavaScript variable name for the binding.
Link to this property
namespace: string
The Messaging namespace to bind to.
Link to this property
type: "messaging"
The kind of resource that the binding provides.
Link to this property
Link to this property
AnalyticsEngine object {dataset, name, type }
dataset: string
The name of the dataset to bind to.
Link to this property
name: string
A JavaScript variable name for the binding.
Link to this property
type: "analytics\_engine"
The kind of resource that the binding provides.
Link to this property
Link to this property
Artifacts object {name, namespace, type }
name: string
A JavaScript variable name for the binding.
Link to this property
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
Link to this property
type: "artifacts"
The kind of resource that the binding provides.
Link to this property
Link to this property
Assets object {name, type }
name: string
A JavaScript variable name for the binding.
Link to this property
type: "assets"
The kind of resource that the binding provides.
Link to this property
Link to this property
Browser object {name, type }
name: string
A JavaScript variable name for the binding.
Link to this property
type: "browser"
The kind of resource that the binding provides.
Link to this property
Link to this property
D1 object {database\_id, name, type, id }
database\_id: string
Identifier of the D1 database to bind to.
Link to this property
name: string
A JavaScript variable name for the binding.
Link to this property
type: "d1"
The kind of resource that the binding provides.
Link to this property
Deprecatedid: optional string
This property has been renamed to database_id.
Identifier of the D1 database to bind to.
Link to this property
Link to this property
DataBlob object {name, part, type }
name: string
A JavaScript variable name for the binding.
Link to this property
part: string
The name of the file containing the data content. Only accepted for service worker syntax Workers.
Link to this property
Deprecatedtype: "data\_blob"
The kind of resource that the binding provides.
Link to this property
Link to this property
DispatchNamespace object {name, namespace, type, outbound }
name: string
A JavaScript variable name for the binding.
Link to this property
namespace: string
The name of the dispatch namespace.
Link to this property
type: "dispatch\_namespace"
The kind of resource that the binding provides.
Link to this property
outbound: optional object {params, worker }
Outbound worker.
params: optional array of object {name }
Pass information from the Dispatch Worker to the Outbound Worker through the parameters.
name: string
Name of the parameter.
Link to this property
Link to this property
worker: optional object {entrypoint, environment, service }
Outbound worker.
entrypoint: optional string
Entrypoint to invoke on the outbound worker.
Link to this property
environment: optional string
Environment of the outbound worker.
Link to this property
service: optional string
Name of the outbound worker.
Link to this property
Link to this property
Link to this property
Link to this property
DurableObjectNamespace object {name, type, class\_name, 4 more }
name: string
A JavaScript variable name for the binding.
Link to this property
type: "durable\_object\_namespace"
The kind of resource that the binding provides.
Link to this property
class\_name: optional string
The exported class name of the Durable Object.
Link to this property
dispatch\_namespace: optional string
The dispatch namespace the Durable Object script belongs to.
Link to this property
environment: optional string
The environment of the script\_name to bind to.
Link to this property
namespace\_id: optional string
Namespace identifier tag.
maxLength32
Link to this property
script\_name: optional string
The script where the Durable Object is defined, if it is external to this Worker.
Link to this property
Link to this property
Hyperdrive object {id, name, type }
id: string
Identifier of the Hyperdrive connection to bind to.
Link to this property
name: string
A JavaScript variable name for the binding.
Link to this property
type: "hyperdrive"
The kind of resource that the binding provides.
Link to this property
Link to this property
Inherit object {name, type, old\_name, version\_id }
name: string
The name of the inherited binding.
Link to this property
type: "inherit"
The kind of resource that the binding provides.
Link to this property
old\_name: optional 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.
Link to this property
version\_id: optional 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.
Link to this property
Link to this property
Images object {name, type }
name: string
A JavaScript variable name for the binding.
Link to this property
type: "images"
The kind of resource that the binding provides.
Link to this property
Link to this property
Json object {json, name, type }
json: unknown
JSON data to use.
Link to this property
name: string
A JavaScript variable name for the binding.
Link to this property
type: "json"
The kind of resource that the binding provides.
Link to this property
Link to this property
KVNamespace object {name, namespace\_id, type }
name: string
A JavaScript variable name for the binding.
Link to this property
namespace\_id: string
Namespace identifier tag.
maxLength32
Link to this property
type: "kv\_namespace"
The kind of resource that the binding provides.
Link to this property
Link to this property
Media object {name, type }
name: string
A JavaScript variable name for the binding.
Link to this property
type: "media"
The kind of resource that the binding provides.
Link to this property
Link to this property
MTLSCertificate object {certificate\_id, name, type }
certificate\_id: string
Identifier of the certificate to bind to.
Link to this property
name: string
A JavaScript variable name for the binding.
Link to this property
type: "mtls\_certificate"
The kind of resource that the binding provides.
Link to this property
Link to this property
PlainText object {name, text, type }
name: string
A JavaScript variable name for the binding.
Link to this property
text: string
The text value to use.
Link to this property
type: "plain\_text"
The kind of resource that the binding provides.
Link to this property
Link to this property
Pipelines object {name, pipeline, type }
name: string
A JavaScript variable name for the binding.
Link to this property
pipeline: string
Name of the Pipeline to bind to.
Link to this property
type: "pipelines"
The kind of resource that the binding provides.
Link to this property
Link to this property
K2 object {name, stream, type }
A K2 stream binding. Available only to accounts enabled for K2.
name: string
A JavaScript variable name for the binding.
Link to this property
stream: string
ID of a K2 stream owned by the account deploying the Worker.
Link to this property
type: "k2"
The kind of resource that the binding provides.
Link to this property
Link to this property
Queue object {name, queue\_name, type }
name: string
A JavaScript variable name for the binding.
Link to this property
queue\_name: string
Name of the Queue to bind to.
Link to this property
type: "queue"
The kind of resource that the binding provides.
Link to this property
Link to this property
Ratelimit object {name, namespace\_id, simple, type }
name: string
A JavaScript variable name for the binding.
Link to this property
namespace\_id: string
Identifier of the rate limit namespace to bind to.
Link to this property
simple: object {limit, period, mitigation\_timeout }
The rate limit configuration.
limit: number
The limit (requests per period).
Link to this property
period: number
The period in seconds.
Link to this property
mitigation\_timeout: optional 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.
Link to this property
Link to this property
type: "ratelimit"
The kind of resource that the binding provides.
Link to this property
Link to this property
R2Bucket object {bucket\_name, name, type, jurisdiction }
bucket\_name: string
R2 bucket to bind to.
Link to this property
name: string
A JavaScript variable name for the binding.
Link to this property
type: "r2\_bucket"
The kind of resource that the binding provides.
Link to this property
jurisdiction: optional "eu"or "fedramp"or "fedramp-high"or "us"
The jurisdiction of the R2 bucket.
One of the following:
"eu"
Link to this property
"fedramp"
Link to this property
"fedramp-high"
Link to this property
"us"
Link to this property
Link to this property
Link to this property
SecretText object {name, text, type }
name: string
A JavaScript variable name for the binding.
Link to this property
text: string
The secret value to use.
Link to this property
type: "secret\_text"
The kind of resource that the binding provides.
Link to this property
Link to this property
SendEmail object {name, type, allowed\_destination\_addresses, 2 more }
name: string
A JavaScript variable name for the binding.
Link to this property
type: "send\_email"
The kind of resource that the binding provides.
Link to this property
allowed\_destination\_addresses: optional array of string
List of allowed destination addresses.
Link to this property
allowed\_sender\_addresses: optional array of string
List of allowed sender addresses.
Link to this property
destination\_address: optional string
Destination address for the email.
formatemail
Link to this property
Link to this property
Service object {name, service, type, 2 more }
name: string
A JavaScript variable name for the binding.
Link to this property
service: string
Name of Worker to bind to.
Link to this property
type: "service"
The kind of resource that the binding provides.
Link to this property
entrypoint: optional string
Entrypoint to invoke on the target Worker.
Link to this property
environment: optional string
Optional environment if the Worker utilizes one.
Link to this property
Link to this property
TextBlob object {name, part, type }
name: string
A JavaScript variable name for the binding.
Link to this property
part: string
The name of the file containing the text content. Only accepted for service worker syntax Workers.
Link to this property
Deprecatedtype: "text\_blob"
The kind of resource that the binding provides.
Link to this property
Link to this property
Vectorize object {index\_name, name, type }
index\_name: string
Name of the Vectorize index to bind to.
Link to this property
name: string
A JavaScript variable name for the binding.
Link to this property
type: "vectorize"
The kind of resource that the binding provides.
Link to this property
Link to this property
VersionMetadata object {name, type }
name: string
A JavaScript variable name for the binding.
Link to this property
type: "version\_metadata"
The kind of resource that the binding provides.
Link to this property
Link to this property
SecretsStoreSecret object {name, secret\_name, store\_id, type }
name: string
A JavaScript variable name for the binding.
Link to this property
secret\_name: string
Name of the secret in the store.
Link to this property
store\_id: string
ID of the store containing the secret.
Link to this property
type: "secrets\_store\_secret"
The kind of resource that the binding provides.
Link to this property
Link to this property
Flagship object {app\_id, name, type }
app\_id: string
ID of the Flagship app to bind to for feature flag evaluation.
maxLength128
Link to this property
name: string
A JavaScript variable name for the binding.
Link to this property
type: "flagship"
The kind of resource that the binding provides.
Link to this property
Link to this property
SecretKey object {algorithm, format, name, 4 more }
algorithm: unknown
Algorithm-specific key parameters. Learn more.
Link to this property
format: "raw"or "pkcs8"or "spki"or "jwk"
Data format of the key. Learn more.
One of the following:
"raw"
Link to this property
"pkcs8"
Link to this property
"spki"
Link to this property
"jwk"
Link to this property
Link to this property
name: string
A JavaScript variable name for the binding.
Link to this property
type: "secret\_key"
The kind of resource that the binding provides.
Link to this property
usages: array of "encrypt"or "decrypt"or "sign"or 5 more
Allowed operations with the key. Learn more.
One of the following:
"encrypt"
Link to this property
"decrypt"
Link to this property
"sign"
Link to this property
"verify"
Link to this property
"deriveKey"
Link to this property
"deriveBits"
Link to this property
"wrapKey"
Link to this property
"unwrapKey"
Link to this property
Link to this property
key\_base64: optional string
Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”.
Link to this property
key\_jwk: optional unknown
Key data in JSON Web Key format. Required if format is “jwk”.
Link to this property
Link to this property
Workflow object {name, type, workflow\_name, 2 more }
name: string
A JavaScript variable name for the binding.
Link to this property
type: "workflow"
The kind of resource that the binding provides.
Link to this property
workflow\_name: string
Name of the Workflow to bind to.
Link to this property
class\_name: optional string
Class name of the Workflow. Should only be provided if the Workflow belongs to this script.
Link to this property
script\_name: optional string
Script name that contains the Workflow. If not provided, defaults to this script name.
Link to this property
Link to this property
WasmModule object {name, part, type }
name: string
A JavaScript variable name for the binding.
Link to this property
part: string
The name of the file containing the WebAssembly module content. Only accepted for service worker syntax Workers.
Link to this property
Deprecatedtype: "wasm\_module"
The kind of resource that the binding provides.
Link to this property
Link to this property
VPCService object {name, service\_id, type }
name: string
A JavaScript variable name for the binding.
Link to this property
service\_id: string
Identifier of the VPC service to bind to.
Link to this property
type: "vpc\_service"
The kind of resource that the binding provides.
Link to this property
Link to this property
VPCNetwork object {name, type, identity, 2 more }
name: string
A JavaScript variable name for the binding.
Link to this property
type: "vpc\_network"
The kind of resource that the binding provides.
Link to this property
identity: optional "runtime-email-alpha"
Enables Gateway identity for the binding. Requires network\_id to be “cf1:network” and cannot be combined with tunnel\_id.
Link to this property
network\_id: optional string
Identifier of the network to bind to. Only “cf1:network” is currently supported. Mutually exclusive with tunnel\_id.
Link to this property
tunnel\_id: optional string
UUID of the Cloudflare Tunnel to bind to. Mutually exclusive with network\_id.
Link to this property
Link to this property
Link to this property
cache\_options: optional object {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.
Link to this property
cross\_version\_cache: optional 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.
Link to this property
Link to this property
compatibility\_date: optional string
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
Link to this property
compatibility\_flags: optional array of 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.
Link to this property
exports: optional map\[object {type, cache, state } or object {storage, type, container, state } or object {state, type } or 3 more]
Declarative exports for the Worker. Worker entrypoint entries (type: worker) carry cache configuration for that entrypoint.
One of the following:
Worker object {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.
Link to this property
cache: optional object {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.
Link to this property
Link to this property
state: optional "created"
Live export. May be omitted; defaults to created.
Link to this property
Link to this property
WorkersDurableObjectExport object {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"or "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"
Link to this property
"legacy-kv"
Link to this property
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
container: optional 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
Link to this property
state: optional "created"
Live export. May be omitted; defaults to created.
Link to this property
Link to this property
WorkersDurableObjectDeletedExport object {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.
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
Link to this property
WorkersDurableObjectRenamedExport object {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
Link to this property
state: "renamed"
Tombstone that renames the namespace’s class.
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
Link to this property
WorkersDurableObjectTransferredExport object {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.
Link to this property
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
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
Link to this property
WorkersDurableObjectExpectingTransferExport object {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.
Link to this property
storage: "sqlite"or "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"
Link to this property
"legacy-kv"
Link to this property
Link to this property
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
Link to this property
type: "durable-object"
Marks this entry as a Durable Object export.
Link to this property
container: optional 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
Link to this property
Link to this property
Link to this property
exports\_reconciliation: optional object {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 of string
Class names for which a new namespace was provisioned.
Link to this property
deleted: array of string
Class names whose namespace was deleted by a deleted tombstone.
Link to this property
info: array of object {class, message, scenario, 2 more }
Non-blocking info entries (stale tombstones, tombstone applied with class still in code). See exports_reconciliation_info.
class: string
The class name the info entry is about.
Link to this property
message: string
Human-readable explanation.
Link to this property
scenario: "code\_class\_not\_in\_exports"or "provisioned\_class\_missing\_from\_config"or "config\_export\_not\_in\_code"or 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"
Link to this property
"provisioned\_class\_missing\_from\_config"
Link to this property
"config\_export\_not\_in\_code"
Link to this property
"config\_references\_nonexistent\_class"
Link to this property
"orphaned\_provisioned\_namespace"
Link to this property
"storage\_type\_mismatch"
Link to this property
"free\_tier\_requires\_sqlite"
Link to this property
"invalid\_export"
Link to this property
"tombstone\_delete\_class\_still\_in\_code"
Link to this property
"tombstone\_delete\_blocked\_by\_external\_bindings"
Link to this property
"tombstone\_renamed\_to\_occupied"
Link to this property
"transferred\_pending\_not\_found"
Link to this property
"transferred\_target\_missing"
Link to this property
"transferred\_target\_mismatch"
Link to this property
"phase\_one\_transfer\_source\_missing"
Link to this property
"phase\_one\_transfer\_source\_namespace\_missing"
Link to this property
"phase\_one\_transfer\_target\_class\_provisioned"
Link to this property
"phase\_one\_transfer\_after\_commit\_mismatch"
Link to this property
"phase\_one\_transfer\_duplicate"
Link to this property
"phase\_one\_transfer\_target\_in\_dispatch\_namespace"
Link to this property
"phase\_one\_transfer\_source\_in\_dispatch\_namespace"
Link to this property
"transferred\_source\_in\_dispatch\_namespace"
Link to this property
"transferred\_target\_in\_dispatch\_namespace"
Link to this property
"container\_undeclared\_reference"
Link to this property
"container\_class\_not\_durable\_object"
Link to this property
"container\_wiring\_inconsistent"
Link to this property
"container\_multiple\_durable\_objects"
Link to this property
"transfer\_container\_parity\_mismatch"
Link to this property
"transfer\_container\_parity\_mismatch\_on\_commit"
Link to this property
"tombstone\_class\_still\_in\_code"
Link to this property
"stale\_tombstone"
Link to this property
"transfer\_receive\_already\_applied"
Link to this property
"transfer\_receive\_cleanup\_complete"
Link to this property
Link to this property
namespace\_id: optional string
The provisioned namespace the entry relates to, when applicable.
formatuuid
Link to this property
referencing\_scripts: optional array of 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.
Link to this property
Link to this property
removable\_entries: array of string
Source class names whose tombstone entry is now stale and safe to delete from exports (no remaining referencing scripts).
Link to this property
renamed: array of object {from, to }
Applied renamed tombstones.
from: string
The original (source) class name.
Link to this property
to: string
The new class name (renamed_to).
Link to this property
Link to this property
transfer\_pending: array of object {class, from }
Phase-1 transfer hints recorded on the target side.
class: string
The target-side class name awaiting transfer.
Link to this property
from: string
The source script the namespace will be transferred from.
Link to this property
Link to this property
transferred: array of object {class, phase, to }
Committed transferred tombstones (phase-2).
class: string
The source class name that was transferred.
Link to this property
phase: "committed"
The transfer phase. Currently always committed.
Link to this property
to: string
The destination script that now owns the namespace.
Link to this property
Link to this property
updated: array of string
Class names whose provisioned namespace was mutated in place.
Link to this property
warnings: array of object {class, message, scenario, namespace\_id }
Non-blocking warnings. See exports_reconciliation_warning.
class: string
The class name the warning is about.
Link to this property
message: string
Human-readable explanation of the warning.
Link to this property
scenario: "code\_class\_not\_in\_exports"or "provisioned\_class\_missing\_from\_config"or "config\_export\_not\_in\_code"or 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"
Link to this property
"provisioned\_class\_missing\_from\_config"
Link to this property
"config\_export\_not\_in\_code"
Link to this property
"config\_references\_nonexistent\_class"
Link to this property
"orphaned\_provisioned\_namespace"
Link to this property
"storage\_type\_mismatch"
Link to this property
"free\_tier\_requires\_sqlite"
Link to this property
"invalid\_export"
Link to this property
"tombstone\_delete\_class\_still\_in\_code"
Link to this property
"tombstone\_delete\_blocked\_by\_external\_bindings"
Link to this property
"tombstone\_renamed\_to\_occupied"
Link to this property
"transferred\_pending\_not\_found"
Link to this property
"transferred\_target\_missing"
Link to this property
"transferred\_target\_mismatch"
Link to this property
"phase\_one\_transfer\_source\_missing"
Link to this property
"phase\_one\_transfer\_source\_namespace\_missing"
Link to this property
"phase\_one\_transfer\_target\_class\_provisioned"
Link to this property
"phase\_one\_transfer\_after\_commit\_mismatch"
Link to this property
"phase\_one\_transfer\_duplicate"
Link to this property
"phase\_one\_transfer\_target\_in\_dispatch\_namespace"
Link to this property
"phase\_one\_transfer\_source\_in\_dispatch\_namespace"
Link to this property
"transferred\_source\_in\_dispatch\_namespace"
Link to this property
"transferred\_target\_in\_dispatch\_namespace"
Link to this property
"container\_undeclared\_reference"
Link to this property
"container\_class\_not\_durable\_object"
Link to this property
"container\_wiring\_inconsistent"
Link to this property
"container\_multiple\_durable\_objects"
Link to this property
"transfer\_container\_parity\_mismatch"
Link to this property
"transfer\_container\_parity\_mismatch\_on\_commit"
Link to this property
"tombstone\_class\_still\_in\_code"
Link to this property
"stale\_tombstone"
Link to this property
"transfer\_receive\_already\_applied"
Link to this property
"transfer\_receive\_cleanup\_complete"
Link to this property
Link to this property
namespace\_id: optional string
The provisioned namespace the warning relates to, when applicable.
formatuuid
Link to this property
Link to this property
Link to this property
limits: optional object {cpu\_ms, subrequests }
Limits to apply for this Worker.
cpu\_ms: optional number
The amount of CPU time this Worker can use in milliseconds.
Link to this property
subrequests: optional number
The number of subrequests this Worker can make per request.
Link to this property
Link to this property
logpush: optional boolean
Whether Logpush is turned on for the Worker.
Link to this property
migrations: optional SingleStepMigration { deleted\_classes, new\_classes, new\_sqlite\_classes, 4 more } or object {new\_tag, old\_tag, steps }
Migrations to apply for Durable Objects associated with this Worker.
One of the following:
SingleStepMigration object {deleted\_classes, new\_classes, new\_sqlite\_classes, 4 more }
A single set of migrations to apply.
deleted\_classes: optional array of string
A list of classes to delete Durable Object namespaces from.
Link to this property
new\_classes: optional array of string
A list of classes to create Durable Object namespaces from.
Link to this property
new\_sqlite\_classes: optional array of string
A list of classes to create Durable Object namespaces with SQLite from.
Link to this property
new\_tag: optional string
Tag to set as the latest migration tag.
Link to this property
old\_tag: optional string
Tag used to verify against the latest migration tag for this Worker. If they don’t match, the upload is rejected.
Link to this property
renamed\_classes: optional array of object {from, to }
A list of classes with Durable Object namespaces that were renamed.
from: optional string
Link to this property
to: optional string
Link to this property
Link to this property
transferred\_classes: optional array of object {from, from\_script, to }
A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker.
from: optional string
Link to this property
from\_script: optional string
Link to this property
to: optional string
Link to this property
Link to this property
Link to this property
WorkersMultipleStepMigrations object {new\_tag, old\_tag, steps }
new\_tag: optional string
Tag to set as the latest migration tag.
Link to this property
old\_tag: optional string
Tag used to verify against the latest migration tag for this Worker. If they don’t match, the upload is rejected.
Link to this property
steps: optional array of MigrationStep { deleted\_classes, new\_classes, new\_sqlite\_classes, 2 more }
Migrations to apply in order.
deleted\_classes: optional array of string
A list of classes to delete Durable Object namespaces from.
Link to this property
new\_classes: optional array of string
A list of classes to create Durable Object namespaces from.
Link to this property
new\_sqlite\_classes: optional array of string
A list of classes to create Durable Object namespaces with SQLite from.
Link to this property
renamed\_classes: optional array of object {from, to }
A list of classes with Durable Object namespaces that were renamed.
from: optional string
Link to this property
to: optional string
Link to this property
Link to this property
transferred\_classes: optional array of object {from, from\_script, to }
A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker.
from: optional string
Link to this property
from\_script: optional string
Link to this property
to: optional string
Link to this property
Link to this property
Link to this property
Link to this property
Link to this property
observability: optional object {enabled, head\_sampling\_rate, issues, 3 more }
Observability settings for the Worker.
enabled: boolean
Whether observability is enabled for the Worker.
Link to this property
head\_sampling\_rate: optional number
The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
Link to this property
issues: optional object {enabled }
Real-time Issues settings for the Worker.
enabled: optional boolean
Whether real-time Issues are enabled for the Worker.
Link to this property
Link to this property
logs: optional object {enabled, invocation\_logs, destinations, 2 more }
Log settings for the Worker.
enabled: boolean
Whether logs are enabled for the Worker.
Link to this property
invocation\_logs: boolean
Whether invocation logs are enabled for the Worker.
Link to this property
destinations: optional array of string
A list of destinations where logs will be exported to.
Link to this property
head\_sampling\_rate: optional number
The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
Link to this property
persist: optional boolean
Whether log persistence is enabled for the Worker.
Link to this property
Link to this property
redact\_query\_string: optional boolean
Whether query strings are removed from request URLs in logs and traces.
Link to this property
traces: optional object {destinations, enabled, head\_sampling\_rate, 2 more }
Trace settings for the Worker.
destinations: optional array of string
A list of destinations where traces will be exported to.
Link to this property
enabled: optional boolean
Whether traces are enabled for the Worker.
Link to this property
head\_sampling\_rate: optional number
The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
Link to this property
persist: optional boolean
Whether trace persistence is enabled for the Worker.
Link to this property
propagation\_policy: optional "authenticated"or "accept"
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"
Link to this property
"accept"
Link to this property
Link to this property
Link to this property
Link to this property
placement: optional object {mode } or object {region } or object {hostname } or 5 more
Configuration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host.
One of the following:
Mode object {mode }
mode: "smart"
Enables Smart Placement.
Link to this property
Link to this property
Region object {region }
region: string
Cloud region for targeted placement in format ‘provider:region’.
Link to this property
Link to this property
Hostname object {hostname }
hostname: string
HTTP hostname for targeted placement.
Link to this property
Link to this property
Host object {host }
host: string
TCP host and port for targeted placement.
Link to this property
Link to this property
object {mode, region }
mode: "targeted"
Targeted placement mode.
Link to this property
region: string
Cloud region for targeted placement in format ‘provider:region’.
Link to this property
Link to this property
object {hostname, mode }
hostname: string
HTTP hostname for targeted placement.
Link to this property
mode: "targeted"
Targeted placement mode.
Link to this property
Link to this property
object {host, mode }
host: string
TCP host and port for targeted placement.
Link to this property
mode: "targeted"
Targeted placement mode.
Link to this property
Link to this property
object {mode, target }
mode: "targeted"
Targeted placement mode.
Link to this property
target: array of object {region } or object {hostname } or object {host }
Array of placement targets (currently limited to single target).
One of the following:
Region object {region }
region: string
Cloud region in format ‘provider:region’.
Link to this property
Link to this property
Hostname object {hostname }
hostname: string
HTTP hostname for targeted placement.
Link to this property
Link to this property
Host object {host }
host: string
TCP host:port for targeted placement.
Link to this property
Link to this property
Link to this property
Link to this property
Link to this property
tags: optional array of string
Tags associated with the Worker.
Link to this property
tail\_consumers: optional array of ConsumerScript { service, environment, namespace }
List of Workers that will consume logs from the attached Worker.
service: string
Name of Worker that is to be the consumer.
Link to this property
environment: optional string
Optional environment if the Worker utilizes one.
Link to this property
namespace: optional string
Optional dispatch namespace the script belongs to.
Link to this property
Link to this property
usage\_model: optional "standard"or "bundled"or "unbound"
Usage model for the Worker invocations.
One of the following:
"standard"
Link to this property
"bundled"
Link to this property
"unbound"
Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts.script_and_version_settings%20%3E%20(model)%20script_and_version_setting_edit_response%20%3E%20(schema)>)