Scripts
List Workers
Search Workers
Download Worker
Upload Worker Module
Delete Worker
ModelsExpand Collapse
Script object { id, cache_options, compatibility_date, 20 more }
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.
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.
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
The tag of the Durable Object migration that was most recently applied for this Worker.
named_handlers: optional array of object { handlers, name } Named exports, such as Durable Object class implementations and named entrypoints.
Named exports, such as Durable Object class implementations and named entrypoints.
observability: optional object { enabled, head_sampling_rate, logs, traces } Observability settings for the Worker.
Observability settings for the Worker.
The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
logs: optional object { enabled, invocation_logs, destinations, 2 more } Log settings for the Worker.
Log settings for the Worker.
Whether invocation logs are enabled for the Worker.
traces: optional object { destinations, enabled, head_sampling_rate, 2 more } Trace settings for the Worker.
Trace settings for the Worker.
The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
propagation_policy: optional "authenticated" or "accept"Controls how inbound trace context (traceparent/tracestate) headers on incoming requests are handled. “authenticated” (default) 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.
Controls how inbound trace context (traceparent/tracestate) headers on incoming requests are handled. “authenticated” (default) 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.
placement: optional object { mode, last_analyzed_at, status } or object { region, last_analyzed_at, status } or object { hostname, last_analyzed_at, status } or 5 moreConfiguration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host.
Configuration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host.
object { mode, last_analyzed_at, status }
Enables Smart Placement.
The last time the script was analyzed for Smart Placement.
status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
object { region, last_analyzed_at, status }
The last time the script was analyzed for Smart Placement.
status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
object { hostname, last_analyzed_at, status }
The last time the script was analyzed for Smart Placement.
status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
object { host, last_analyzed_at, status }
The last time the script was analyzed for Smart Placement.
status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
object { mode, region, last_analyzed_at, status }
The last time the script was analyzed for Smart Placement.
status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
object { hostname, mode, last_analyzed_at, status }
The last time the script was analyzed for Smart Placement.
status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
object { host, mode, last_analyzed_at, status }
The last time the script was analyzed for Smart Placement.
status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
object { mode, target, last_analyzed_at, status }
target: array of object { region } or object { hostname } or object { host } Array of placement targets (currently limited to single target).
Array of placement targets (currently limited to single target).
The last time the script was analyzed for Smart Placement.
status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
Deprecatedplacement_mode: optional "smart" or "targeted"Configuration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host.
Configuration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host.
Deprecatedplacement_status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
ScriptSetting object { logpush, observability, tags, tail_consumers }
observability: optional object { enabled, head_sampling_rate, logs, traces } Observability settings for the Worker.
Observability settings for the Worker.
The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
logs: optional object { enabled, invocation_logs, destinations, 2 more } Log settings for the Worker.
Log settings for the Worker.
Whether invocation logs are enabled for the Worker.
traces: optional object { destinations, enabled, head_sampling_rate, 2 more } Trace settings for the Worker.
Trace settings for the Worker.
The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
propagation_policy: optional "authenticated" or "accept"Controls how inbound trace context (traceparent/tracestate) headers on incoming requests are handled. “authenticated” (default) 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.
Controls how inbound trace context (traceparent/tracestate) headers on incoming requests are handled. “authenticated” (default) 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.
ScriptListResponse object { id, cache_options, compatibility_date, 21 more }
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.
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.
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
The tag of the Durable Object migration that was most recently applied for this Worker.
named_handlers: optional array of object { handlers, name } Named exports, such as Durable Object class implementations and named entrypoints.
Named exports, such as Durable Object class implementations and named entrypoints.
observability: optional object { enabled, head_sampling_rate, logs, traces } Observability settings for the Worker.
Observability settings for the Worker.
The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
logs: optional object { enabled, invocation_logs, destinations, 2 more } Log settings for the Worker.
Log settings for the Worker.
Whether invocation logs are enabled for the Worker.
traces: optional object { destinations, enabled, head_sampling_rate, 2 more } Trace settings for the Worker.
Trace settings for the Worker.
The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
propagation_policy: optional "authenticated" or "accept"Controls how inbound trace context (traceparent/tracestate) headers on incoming requests are handled. “authenticated” (default) 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.
Controls how inbound trace context (traceparent/tracestate) headers on incoming requests are handled. “authenticated” (default) 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.
placement: optional object { mode, last_analyzed_at, status } or object { region, last_analyzed_at, status } or object { hostname, last_analyzed_at, status } or 5 moreConfiguration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host.
Configuration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host.
object { mode, last_analyzed_at, status }
Enables Smart Placement.
The last time the script was analyzed for Smart Placement.
status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
object { region, last_analyzed_at, status }
The last time the script was analyzed for Smart Placement.
status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
object { hostname, last_analyzed_at, status }
The last time the script was analyzed for Smart Placement.
status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
object { host, last_analyzed_at, status }
The last time the script was analyzed for Smart Placement.
status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
object { mode, region, last_analyzed_at, status }
The last time the script was analyzed for Smart Placement.
status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
object { hostname, mode, last_analyzed_at, status }
The last time the script was analyzed for Smart Placement.
status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
object { host, mode, last_analyzed_at, status }
The last time the script was analyzed for Smart Placement.
status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
object { mode, target, last_analyzed_at, status }
target: array of object { region } or object { hostname } or object { host } Array of placement targets (currently limited to single target).
Array of placement targets (currently limited to single target).
The last time the script was analyzed for Smart Placement.
status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
Deprecatedplacement_status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"
routes: optional array of object { id, pattern, script } Routes associated with the Worker.
Routes associated with the Worker.
Pattern to match incoming requests against. Learn more.
ScriptUpdateResponse object { startup_time_ms, id, cache_options, 22 more }
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.
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.
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
The tag of the Durable Object migration that was most recently applied for this Worker.
named_handlers: optional array of object { handlers, name } Named exports, such as Durable Object class implementations and named entrypoints.
Named exports, such as Durable Object class implementations and named entrypoints.
observability: optional object { enabled, head_sampling_rate, logs, traces } Observability settings for the Worker.
Observability settings for the Worker.
The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
logs: optional object { enabled, invocation_logs, destinations, 2 more } Log settings for the Worker.
Log settings for the Worker.
Whether invocation logs are enabled for the Worker.
traces: optional object { destinations, enabled, head_sampling_rate, 2 more } Trace settings for the Worker.
Trace settings for the Worker.
The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
propagation_policy: optional "authenticated" or "accept"Controls how inbound trace context (traceparent/tracestate) headers on incoming requests are handled. “authenticated” (default) 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.
Controls how inbound trace context (traceparent/tracestate) headers on incoming requests are handled. “authenticated” (default) 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.
placement: optional object { mode, last_analyzed_at, status } or object { region, last_analyzed_at, status } or object { hostname, last_analyzed_at, status } or 5 moreConfiguration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host.
Configuration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host.
object { mode, last_analyzed_at, status }
Enables Smart Placement.
The last time the script was analyzed for Smart Placement.
status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
object { region, last_analyzed_at, status }
The last time the script was analyzed for Smart Placement.
status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
object { hostname, last_analyzed_at, status }
The last time the script was analyzed for Smart Placement.
status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
object { host, last_analyzed_at, status }
The last time the script was analyzed for Smart Placement.
status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
object { mode, region, last_analyzed_at, status }
The last time the script was analyzed for Smart Placement.
status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
object { hostname, mode, last_analyzed_at, status }
The last time the script was analyzed for Smart Placement.
status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
object { host, mode, last_analyzed_at, status }
The last time the script was analyzed for Smart Placement.
status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
object { mode, target, last_analyzed_at, status }
target: array of object { region } or object { hostname } or object { host } Array of placement targets (currently limited to single target).
Array of placement targets (currently limited to single target).
The last time the script was analyzed for Smart Placement.
status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"Status of Smart Placement.
Status of Smart Placement.
Deprecatedplacement_status: optional "SUCCESS" or "UNSUPPORTED_APPLICATION" or "INSUFFICIENT_INVOCATIONS"
ScriptsAssets
ScriptsAssetsUpload
Create Assets Upload Session
ScriptsSubdomain
Get Worker subdomain
Post Worker subdomain
Delete Worker subdomain
ModelsExpand Collapse
ScriptsSchedules
Get Cron Triggers
Update Cron Triggers
ModelsExpand Collapse
ScriptsTail
List Tails
Start Tail
Delete Tail
ModelsExpand Collapse
ScriptsContent
Get script content
Put script content
ScriptsSettings
Get Script Settings
Patch Script Settings
ScriptsDeployments
List Deployments
Create Deployment
Get Deployment
Delete Deployment
ModelsExpand Collapse
ScriptsVersions
List Versions
Get Version Detail
Upload Version
ModelsExpand Collapse
VersionGetResponse object { resources, id, metadata, number }
resources: object { bindings, script, script_runtime }
bindings: optional array of object { name, type } or object { instance_name, name, type, namespace } or object { name, namespace, type } or 32 moreList 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.
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.
AISearch object { instance_name, name, type, namespace }
AISearchNamespace object { name, namespace, type }
DispatchNamespace object { name, namespace, type, outbound }
Inherit object { name, type, old_name, version_id }
Ratelimit object { name, namespace_id, simple, type }
R2Bucket object { bucket_name, name, type, jurisdiction }
jurisdiction: optional "eu" or "fedramp" or "fedramp-high"The jurisdiction of the R2 bucket.
The jurisdiction of the R2 bucket.
SecretKey object { algorithm, format, name, 4 more }
Algorithm-specific key parameters. Learn more.
format: "raw" or "pkcs8" or "spki" or "jwk"Data format of the key. Learn more.
Data format of the key. Learn more.
usages: array of "encrypt" or "decrypt" or "sign" or 5 moreAllowed operations with the key. Learn more.
Allowed operations with the key. Learn more.
Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”.
Key data in JSON Web Key format. Required if format is “jwk”.
Workflow object { name, type, workflow_name, 2 more }
script: optional object { etag, handlers, last_deployed_from, named_handlers }
script_runtime: optional object { compatibility_date, compatibility_flags, exports, 3 more } Runtime configuration for the Worker.
Runtime configuration for the Worker.
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
Flags that enable or disable certain features in the Workers runtime.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
VersionCreateResponse object { resources, id, exports_reconciliation, 3 more }
resources: object { bindings, script, script_runtime }
bindings: optional array of object { name, type } or object { instance_name, name, type, namespace } or object { name, namespace, type } or 32 moreList 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.
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.
AISearch object { instance_name, name, type, namespace }
AISearchNamespace object { name, namespace, type }
DispatchNamespace object { name, namespace, type, outbound }
Inherit object { name, type, old_name, version_id }
Ratelimit object { name, namespace_id, simple, type }
R2Bucket object { bucket_name, name, type, jurisdiction }
jurisdiction: optional "eu" or "fedramp" or "fedramp-high"The jurisdiction of the R2 bucket.
The jurisdiction of the R2 bucket.
SecretKey object { algorithm, format, name, 4 more }
Algorithm-specific key parameters. Learn more.
format: "raw" or "pkcs8" or "spki" or "jwk"Data format of the key. Learn more.
Data format of the key. Learn more.
usages: array of "encrypt" or "decrypt" or "sign" or 5 moreAllowed operations with the key. Learn more.
Allowed operations with the key. Learn more.
Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”.
Key data in JSON Web Key format. Required if format is “jwk”.
Workflow object { name, type, workflow_name, 2 more }
script: optional object { etag, handlers, last_deployed_from, named_handlers }
script_runtime: optional object { compatibility_date, compatibility_flags, exports, 3 more } Runtime configuration for the Worker.
Runtime configuration for the Worker.
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
Flags that enable or disable certain features in the Workers runtime.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Non-blocking info entries (stale tombstones, tombstone applied
with class still in code). See exports_reconciliation_info.
scenario: "code_class_not_in_exports" or "provisioned_class_missing_from_config" or "config_export_not_in_code" or 30 moreStable, machine-readable tag identifying which reconciliation
scenario produced an error, warning, or info entry. Clients may
branch on this value instead of parsing message.
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.
Source class names whose tombstone entry is now stale and safe
to delete from exports (no remaining referencing scripts).
transfer_pending: array of object { class, from } Phase-1 transfer hints recorded on the target side.
Phase-1 transfer hints recorded on the target side.
warnings: array of object { class, message, scenario, namespace_id } Non-blocking warnings. See exports_reconciliation_warning.
Non-blocking warnings. See exports_reconciliation_warning.
scenario: "code_class_not_in_exports" or "provisioned_class_missing_from_config" or "config_export_not_in_code" or 30 moreStable, machine-readable tag identifying which reconciliation
scenario produced an error, warning, or info entry. Clients may
branch on this value instead of parsing message.
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.
Time in milliseconds spent on Worker startup.
ScriptsSecrets
List script secrets
Get secret binding
Add script secret
Delete script secret
Patch multiple script secrets
ModelsExpand Collapse
SecretListResponse = object { name, text, type } or object { algorithm, format, name, 4 more } A secret value accessible through a binding.
A secret value accessible through a binding.
SecretKey object { algorithm, format, name, 4 more }
Algorithm-specific key parameters. Learn more.
format: "raw" or "pkcs8" or "spki" or "jwk"Data format of the key. Learn more.
Data format of the key. Learn more.
usages: array of "encrypt" or "decrypt" or "sign" or 5 moreAllowed operations with the key. Learn more.
Allowed operations with the key. Learn more.
Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”.
Key data in JSON Web Key format. Required if format is “jwk”.
SecretGetResponse = object { name, text, type } or object { algorithm, format, name, 4 more } A secret value accessible through a binding.
A secret value accessible through a binding.
SecretKey object { algorithm, format, name, 4 more }
Algorithm-specific key parameters. Learn more.
format: "raw" or "pkcs8" or "spki" or "jwk"Data format of the key. Learn more.
Data format of the key. Learn more.
usages: array of "encrypt" or "decrypt" or "sign" or 5 moreAllowed operations with the key. Learn more.
Allowed operations with the key. Learn more.
Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”.
Key data in JSON Web Key format. Required if format is “jwk”.
SecretUpdateResponse = object { name, text, type } or object { algorithm, format, name, 4 more } A secret value accessible through a binding.
A secret value accessible through a binding.
SecretKey object { algorithm, format, name, 4 more }
Algorithm-specific key parameters. Learn more.
format: "raw" or "pkcs8" or "spki" or "jwk"Data format of the key. Learn more.
Data format of the key. Learn more.
usages: array of "encrypt" or "decrypt" or "sign" or 5 moreAllowed operations with the key. Learn more.
Allowed operations with the key. Learn more.
Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”.
Key data in JSON Web Key format. Required if format is “jwk”.
SecretBulkUpdateResponse = map[object { name, text, type } or object { algorithm, format, name, 4 more } ]Map of secret names to secret metadata for resulting secrets.
Map of secret names to secret metadata for resulting secrets.
SecretKey object { algorithm, format, name, 4 more }
Algorithm-specific key parameters. Learn more.
format: "raw" or "pkcs8" or "spki" or "jwk"Data format of the key. Learn more.
Data format of the key. Learn more.
usages: array of "encrypt" or "decrypt" or "sign" or 5 moreAllowed operations with the key. Learn more.
Allowed operations with the key. Learn more.
Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”.
Key data in JSON Web Key format. Required if format is “jwk”.
ScriptsScript And Version Settings
Get Settings
Patch 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.
Annotations for the Worker version. Annotations are not inherited across settings updates; omitting this field means the new version will have no annotations.
bindings: optional array of object { name, type } or object { instance_name, name, type, namespace } or object { name, namespace, type } or 32 moreList 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.
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.
AISearch object { instance_name, name, type, namespace }
AISearchNamespace object { name, namespace, type }
DispatchNamespace object { name, namespace, type, outbound }
Inherit object { name, type, old_name, version_id }
Ratelimit object { name, namespace_id, simple, type }
R2Bucket object { bucket_name, name, type, jurisdiction }
jurisdiction: optional "eu" or "fedramp" or "fedramp-high"The jurisdiction of the R2 bucket.
The jurisdiction of the R2 bucket.
SecretKey object { algorithm, format, name, 4 more }
Algorithm-specific key parameters. Learn more.
format: "raw" or "pkcs8" or "spki" or "jwk"Data format of the key. Learn more.
Data format of the key. Learn more.
usages: array of "encrypt" or "decrypt" or "sign" or 5 moreAllowed operations with the key. Learn more.
Allowed operations with the key. Learn more.
Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”.
Key data in JSON Web Key format. Required if format is “jwk”.
Workflow object { name, type, workflow_name, 2 more }
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.
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.
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
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.
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.
Declarative exports for the Worker. Worker entrypoint entries
(type: worker) carry cache configuration for that entrypoint.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Non-blocking info entries (stale tombstones, tombstone applied
with class still in code). See exports_reconciliation_info.
scenario: "code_class_not_in_exports" or "provisioned_class_missing_from_config" or "config_export_not_in_code" or 30 moreStable, machine-readable tag identifying which reconciliation
scenario produced an error, warning, or info entry. Clients may
branch on this value instead of parsing message.
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.
Source class names whose tombstone entry is now stale and safe
to delete from exports (no remaining referencing scripts).
transfer_pending: array of object { class, from } Phase-1 transfer hints recorded on the target side.
Phase-1 transfer hints recorded on the target side.
warnings: array of object { class, message, scenario, namespace_id } Non-blocking warnings. See exports_reconciliation_warning.
Non-blocking warnings. See exports_reconciliation_warning.
scenario: "code_class_not_in_exports" or "provisioned_class_missing_from_config" or "config_export_not_in_code" or 30 moreStable, machine-readable tag identifying which reconciliation
scenario produced an error, warning, or info entry. Clients may
branch on this value instead of parsing message.
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.
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.
Migrations to apply for Durable Objects associated with this Worker.
SingleStepMigration object { deleted_classes, new_classes, new_sqlite_classes, 4 more } A single set of migrations to apply.
A single set of migrations to apply.
A list of classes to delete Durable Object namespaces from.
A list of classes to create Durable Object namespaces with SQLite from.
Tag used to verify against the latest migration tag for this Worker. If they don’t match, the upload is rejected.
WorkersMultipleStepMigrations object { new_tag, old_tag, steps }
Tag used to verify against the latest migration tag for this Worker. If they don’t match, the upload is rejected.
Migrations to apply in order.
Migrations to apply in order.
A list of classes to delete Durable Object namespaces from.
A list of classes to create Durable Object namespaces with SQLite from.
observability: optional object { enabled, head_sampling_rate, logs, traces } Observability settings for the Worker.
Observability settings for the Worker.
The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
logs: optional object { enabled, invocation_logs, destinations, 2 more } Log settings for the Worker.
Log settings for the Worker.
Whether invocation logs are enabled for the Worker.
traces: optional object { destinations, enabled, head_sampling_rate, 2 more } Trace settings for the Worker.
Trace settings for the Worker.
The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
propagation_policy: optional "authenticated" or "accept"Controls how inbound trace context (traceparent/tracestate) headers on incoming requests are handled. “authenticated” (default) 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.
Controls how inbound trace context (traceparent/tracestate) headers on incoming requests are handled. “authenticated” (default) 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.
placement: optional object { mode } or object { region } or object { hostname } or 5 moreConfiguration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host.
Configuration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host.
Mode object { mode }
Enables Smart Placement.
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.
Annotations for the Worker version. Annotations are not inherited across settings updates; omitting this field means the new version will have no annotations.
bindings: optional array of object { name, type } or object { instance_name, name, type, namespace } or object { name, namespace, type } or 32 moreList 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.
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.
AISearch object { instance_name, name, type, namespace }
AISearchNamespace object { name, namespace, type }
DispatchNamespace object { name, namespace, type, outbound }
Inherit object { name, type, old_name, version_id }
Ratelimit object { name, namespace_id, simple, type }
R2Bucket object { bucket_name, name, type, jurisdiction }
jurisdiction: optional "eu" or "fedramp" or "fedramp-high"The jurisdiction of the R2 bucket.
The jurisdiction of the R2 bucket.
SecretKey object { algorithm, format, name, 4 more }
Algorithm-specific key parameters. Learn more.
format: "raw" or "pkcs8" or "spki" or "jwk"Data format of the key. Learn more.
Data format of the key. Learn more.
usages: array of "encrypt" or "decrypt" or "sign" or 5 moreAllowed operations with the key. Learn more.
Allowed operations with the key. Learn more.
Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”.
Key data in JSON Web Key format. Required if format is “jwk”.
Workflow object { name, type, workflow_name, 2 more }
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.
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.
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
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.
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.
Declarative exports for the Worker. Worker entrypoint entries
(type: worker) carry cache configuration for that entrypoint.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Non-blocking info entries (stale tombstones, tombstone applied
with class still in code). See exports_reconciliation_info.
scenario: "code_class_not_in_exports" or "provisioned_class_missing_from_config" or "config_export_not_in_code" or 30 moreStable, machine-readable tag identifying which reconciliation
scenario produced an error, warning, or info entry. Clients may
branch on this value instead of parsing message.
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.
Source class names whose tombstone entry is now stale and safe
to delete from exports (no remaining referencing scripts).
transfer_pending: array of object { class, from } Phase-1 transfer hints recorded on the target side.
Phase-1 transfer hints recorded on the target side.
warnings: array of object { class, message, scenario, namespace_id } Non-blocking warnings. See exports_reconciliation_warning.
Non-blocking warnings. See exports_reconciliation_warning.
scenario: "code_class_not_in_exports" or "provisioned_class_missing_from_config" or "config_export_not_in_code" or 30 moreStable, machine-readable tag identifying which reconciliation
scenario produced an error, warning, or info entry. Clients may
branch on this value instead of parsing message.
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.
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.
Migrations to apply for Durable Objects associated with this Worker.
SingleStepMigration object { deleted_classes, new_classes, new_sqlite_classes, 4 more } A single set of migrations to apply.
A single set of migrations to apply.
A list of classes to delete Durable Object namespaces from.
A list of classes to create Durable Object namespaces with SQLite from.
Tag used to verify against the latest migration tag for this Worker. If they don’t match, the upload is rejected.
WorkersMultipleStepMigrations object { new_tag, old_tag, steps }
Tag used to verify against the latest migration tag for this Worker. If they don’t match, the upload is rejected.
Migrations to apply in order.
Migrations to apply in order.
A list of classes to delete Durable Object namespaces from.
A list of classes to create Durable Object namespaces with SQLite from.
observability: optional object { enabled, head_sampling_rate, logs, traces } Observability settings for the Worker.
Observability settings for the Worker.
The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
logs: optional object { enabled, invocation_logs, destinations, 2 more } Log settings for the Worker.
Log settings for the Worker.
Whether invocation logs are enabled for the Worker.
traces: optional object { destinations, enabled, head_sampling_rate, 2 more } Trace settings for the Worker.
Trace settings for the Worker.
The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
propagation_policy: optional "authenticated" or "accept"Controls how inbound trace context (traceparent/tracestate) headers on incoming requests are handled. “authenticated” (default) 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.
Controls how inbound trace context (traceparent/tracestate) headers on incoming requests are handled. “authenticated” (default) 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.
placement: optional object { mode } or object { region } or object { hostname } or 5 moreConfiguration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host.
Configuration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host.
Mode object { mode }
Enables Smart Placement.