Scripts
List Workers
Search Workers
Download Worker
Upload Worker Module
Delete Worker
ModelsExpand Collapse
class Script: …
cache_options: Optional[CacheOptions]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[Dict[str, Exports]]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.
class ExportsWorkersWorkerExport: …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.
class ExportsWorkersDurableObjectExport: …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: Literal["sqlite", "legacy-kv"]Durable Object storage backend. sqlite is the recommended (and
only) backend for new namespaces. legacy-kv is accepted only for
a class whose namespace already exists as KV-backed; the exports
flow never provisions a new legacy-kv namespace.
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.
class ExportsWorkersDurableObjectDeletedExport: …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.
class ExportsWorkersDurableObjectRenamedExport: …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.
class ExportsWorkersDurableObjectTransferredExport: …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.
class ExportsWorkersDurableObjectExpectingTransferExport: …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: Literal["sqlite", "legacy-kv"]Durable Object storage backend. sqlite is the recommended (and
only) backend for new namespaces. legacy-kv is accepted only for
a class whose namespace already exists as KV-backed; the exports
flow never provisions a new legacy-kv namespace.
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[List[NamedHandler]]Named exports, such as Durable Object class implementations and named entrypoints.
Named exports, such as Durable Object class implementations and named entrypoints.
observability: Optional[Observability]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[ObservabilityLogs]Log settings for the Worker.
Log settings for the Worker.
Whether invocation logs are enabled for the Worker.
traces: Optional[ObservabilityTraces]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[Literal["authenticated", "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[Placement]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.
class PlacementUnionMember0: …
Enables Smart Placement.
The last time the script was analyzed for Smart Placement.
status: Optional[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
class PlacementUnionMember1: …
The last time the script was analyzed for Smart Placement.
status: Optional[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
class PlacementUnionMember2: …
The last time the script was analyzed for Smart Placement.
status: Optional[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
class PlacementUnionMember3: …
The last time the script was analyzed for Smart Placement.
status: Optional[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
class PlacementUnionMember4: …
The last time the script was analyzed for Smart Placement.
status: Optional[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
class PlacementUnionMember5: …
The last time the script was analyzed for Smart Placement.
status: Optional[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
class PlacementUnionMember6: …
The last time the script was analyzed for Smart Placement.
status: Optional[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
class PlacementUnionMember7: …
target: List[PlacementUnionMember7Target]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[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
Deprecatedplacement_mode: Optional[Literal["smart", "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[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
class ScriptSetting: …
observability: Optional[Observability]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[ObservabilityLogs]Log settings for the Worker.
Log settings for the Worker.
Whether invocation logs are enabled for the Worker.
traces: Optional[ObservabilityTraces]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[Literal["authenticated", "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.
class ScriptListResponse: …
cache_options: Optional[CacheOptions]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[Dict[str, Exports]]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.
class ExportsWorkersWorkerExport: …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.
class ExportsWorkersDurableObjectExport: …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: Literal["sqlite", "legacy-kv"]Durable Object storage backend. sqlite is the recommended (and
only) backend for new namespaces. legacy-kv is accepted only for
a class whose namespace already exists as KV-backed; the exports
flow never provisions a new legacy-kv namespace.
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.
class ExportsWorkersDurableObjectDeletedExport: …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.
class ExportsWorkersDurableObjectRenamedExport: …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.
class ExportsWorkersDurableObjectTransferredExport: …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.
class ExportsWorkersDurableObjectExpectingTransferExport: …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: Literal["sqlite", "legacy-kv"]Durable Object storage backend. sqlite is the recommended (and
only) backend for new namespaces. legacy-kv is accepted only for
a class whose namespace already exists as KV-backed; the exports
flow never provisions a new legacy-kv namespace.
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[List[NamedHandler]]Named exports, such as Durable Object class implementations and named entrypoints.
Named exports, such as Durable Object class implementations and named entrypoints.
observability: Optional[Observability]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[ObservabilityLogs]Log settings for the Worker.
Log settings for the Worker.
Whether invocation logs are enabled for the Worker.
traces: Optional[ObservabilityTraces]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[Literal["authenticated", "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[Placement]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.
class PlacementUnionMember0: …
Enables Smart Placement.
The last time the script was analyzed for Smart Placement.
status: Optional[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
class PlacementUnionMember1: …
The last time the script was analyzed for Smart Placement.
status: Optional[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
class PlacementUnionMember2: …
The last time the script was analyzed for Smart Placement.
status: Optional[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
class PlacementUnionMember3: …
The last time the script was analyzed for Smart Placement.
status: Optional[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
class PlacementUnionMember4: …
The last time the script was analyzed for Smart Placement.
status: Optional[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
class PlacementUnionMember5: …
The last time the script was analyzed for Smart Placement.
status: Optional[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
class PlacementUnionMember6: …
The last time the script was analyzed for Smart Placement.
status: Optional[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
class PlacementUnionMember7: …
target: List[PlacementUnionMember7Target]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[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
Deprecatedplacement_status: Optional[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]
routes: Optional[List[Route]]Routes associated with the Worker.
Routes associated with the Worker.
Pattern to match incoming requests against. Learn more.
class ScriptUpdateResponse: …
cache_options: Optional[CacheOptions]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[Dict[str, Exports]]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.
class ExportsWorkersWorkerExport: …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.
class ExportsWorkersDurableObjectExport: …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: Literal["sqlite", "legacy-kv"]Durable Object storage backend. sqlite is the recommended (and
only) backend for new namespaces. legacy-kv is accepted only for
a class whose namespace already exists as KV-backed; the exports
flow never provisions a new legacy-kv namespace.
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.
class ExportsWorkersDurableObjectDeletedExport: …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.
class ExportsWorkersDurableObjectRenamedExport: …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.
class ExportsWorkersDurableObjectTransferredExport: …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.
class ExportsWorkersDurableObjectExpectingTransferExport: …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: Literal["sqlite", "legacy-kv"]Durable Object storage backend. sqlite is the recommended (and
only) backend for new namespaces. legacy-kv is accepted only for
a class whose namespace already exists as KV-backed; the exports
flow never provisions a new legacy-kv namespace.
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[List[NamedHandler]]Named exports, such as Durable Object class implementations and named entrypoints.
Named exports, such as Durable Object class implementations and named entrypoints.
observability: Optional[Observability]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[ObservabilityLogs]Log settings for the Worker.
Log settings for the Worker.
Whether invocation logs are enabled for the Worker.
traces: Optional[ObservabilityTraces]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[Literal["authenticated", "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[Placement]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.
class PlacementUnionMember0: …
Enables Smart Placement.
The last time the script was analyzed for Smart Placement.
status: Optional[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
class PlacementUnionMember1: …
The last time the script was analyzed for Smart Placement.
status: Optional[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
class PlacementUnionMember2: …
The last time the script was analyzed for Smart Placement.
status: Optional[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
class PlacementUnionMember3: …
The last time the script was analyzed for Smart Placement.
status: Optional[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
class PlacementUnionMember4: …
The last time the script was analyzed for Smart Placement.
status: Optional[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
class PlacementUnionMember5: …
The last time the script was analyzed for Smart Placement.
status: Optional[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
class PlacementUnionMember6: …
The last time the script was analyzed for Smart Placement.
status: Optional[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
class PlacementUnionMember7: …
target: List[PlacementUnionMember7Target]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[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "INSUFFICIENT_INVOCATIONS"]]Status of Smart Placement.
Status of Smart Placement.
Deprecatedplacement_status: Optional[Literal["SUCCESS", "UNSUPPORTED_APPLICATION", "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
ScriptsTail
List Tails
Start Tail
Delete Tail
ScriptsContent
Get script content
Put script content
ScriptsSettings
Get Script Settings
Patch Script Settings
ScriptsDeployments
List Deployments
Create Deployment
Get Deployment
Delete Deployment
ScriptsVersions
List Versions
Get Version Detail
Upload Version
ModelsExpand Collapse
class VersionGetResponse: …
resources: Resources
bindings: Optional[List[ResourcesBinding]]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.
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.
class ResourcesBindingWorkersBindingKindAISearch: …
class ResourcesBindingWorkersBindingKindAISearchNamespace: …
class ResourcesBindingWorkersBindingKindDispatchNamespace: …
class ResourcesBindingWorkersBindingKindInherit: …
class ResourcesBindingWorkersBindingKindRatelimit: …
class ResourcesBindingWorkersBindingKindR2Bucket: …
jurisdiction: Optional[Literal["eu", "fedramp", "fedramp-high"]]The jurisdiction of the R2 bucket.
The jurisdiction of the R2 bucket.
class ResourcesBindingWorkersBindingKindSecretKey: …
Algorithm-specific key parameters. Learn more.
format: Literal["raw", "pkcs8", "spki", "jwk"]Data format of the key. Learn more.
Data format of the key. Learn more.
usages: List[Literal["encrypt", "decrypt", "sign", 5 more]]Allowed operations with the key. Learn more.
Allowed operations with the key. Learn more.
Key data in JSON Web Key format. Required if format is “jwk”.
class ResourcesBindingWorkersBindingKindWorkflow: …
script_runtime: Optional[ResourcesScriptRuntime]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[Dict[str, ResourcesScriptRuntimeExports]]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.
class ResourcesScriptRuntimeExportsWorkersWorkerExport: …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.
class ResourcesScriptRuntimeExportsWorkersDurableObjectExport: …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: Literal["sqlite", "legacy-kv"]Durable Object storage backend. sqlite is the recommended (and
only) backend for new namespaces. legacy-kv is accepted only for
a class whose namespace already exists as KV-backed; the exports
flow never provisions a new legacy-kv namespace.
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.
class ResourcesScriptRuntimeExportsWorkersDurableObjectDeletedExport: …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.
class ResourcesScriptRuntimeExportsWorkersDurableObjectRenamedExport: …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.
class ResourcesScriptRuntimeExportsWorkersDurableObjectTransferredExport: …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.
class ResourcesScriptRuntimeExportsWorkersDurableObjectExpectingTransferExport: …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: Literal["sqlite", "legacy-kv"]Durable Object storage backend. sqlite is the recommended (and
only) backend for new namespaces. legacy-kv is accepted only for
a class whose namespace already exists as KV-backed; the exports
flow never provisions a new legacy-kv namespace.
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.
class VersionCreateResponse: …
resources: Resources
bindings: Optional[List[ResourcesBinding]]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.
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.
class ResourcesBindingWorkersBindingKindAISearch: …
class ResourcesBindingWorkersBindingKindAISearchNamespace: …
class ResourcesBindingWorkersBindingKindDispatchNamespace: …
class ResourcesBindingWorkersBindingKindInherit: …
class ResourcesBindingWorkersBindingKindRatelimit: …
class ResourcesBindingWorkersBindingKindR2Bucket: …
jurisdiction: Optional[Literal["eu", "fedramp", "fedramp-high"]]The jurisdiction of the R2 bucket.
The jurisdiction of the R2 bucket.
class ResourcesBindingWorkersBindingKindSecretKey: …
Algorithm-specific key parameters. Learn more.
format: Literal["raw", "pkcs8", "spki", "jwk"]Data format of the key. Learn more.
Data format of the key. Learn more.
usages: List[Literal["encrypt", "decrypt", "sign", 5 more]]Allowed operations with the key. Learn more.
Allowed operations with the key. Learn more.
Key data in JSON Web Key format. Required if format is “jwk”.
class ResourcesBindingWorkersBindingKindWorkflow: …
script_runtime: Optional[ResourcesScriptRuntime]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[Dict[str, ResourcesScriptRuntimeExports]]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.
class ResourcesScriptRuntimeExportsWorkersWorkerExport: …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.
class ResourcesScriptRuntimeExportsWorkersDurableObjectExport: …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: Literal["sqlite", "legacy-kv"]Durable Object storage backend. sqlite is the recommended (and
only) backend for new namespaces. legacy-kv is accepted only for
a class whose namespace already exists as KV-backed; the exports
flow never provisions a new legacy-kv namespace.
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.
class ResourcesScriptRuntimeExportsWorkersDurableObjectDeletedExport: …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.
class ResourcesScriptRuntimeExportsWorkersDurableObjectRenamedExport: …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.
class ResourcesScriptRuntimeExportsWorkersDurableObjectTransferredExport: …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.
class ResourcesScriptRuntimeExportsWorkersDurableObjectExpectingTransferExport: …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: Literal["sqlite", "legacy-kv"]Durable Object storage backend. sqlite is the recommended (and
only) backend for new namespaces. legacy-kv is accepted only for
a class whose namespace already exists as KV-backed; the exports
flow never provisions a new legacy-kv namespace.
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[ExportsReconciliation]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: List[ExportsReconciliationInfo]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: Literal["code_class_not_in_exports", "provisioned_class_missing_from_config", "config_export_not_in_code", 30 more]Stable, machine-readable tag identifying which reconciliation
scenario produced an error, warning, or info entry. Clients may
branch on this value instead of parsing message.
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: List[ExportsReconciliationTransferPending]Phase-1 transfer hints recorded on the target side.
Phase-1 transfer hints recorded on the target side.
warnings: List[ExportsReconciliationWarning]Non-blocking warnings. See exports_reconciliation_warning.
Non-blocking warnings. See exports_reconciliation_warning.
scenario: Literal["code_class_not_in_exports", "provisioned_class_missing_from_config", "config_export_not_in_code", 30 more]Stable, machine-readable tag identifying which reconciliation
scenario produced an error, warning, or info entry. Clients may
branch on this value instead of parsing message.
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
A secret value accessible through a binding.
A secret value accessible through a binding.
class WorkersBindingKindSecretKey: …
Algorithm-specific key parameters. Learn more.
format: Literal["raw", "pkcs8", "spki", "jwk"]Data format of the key. Learn more.
Data format of the key. Learn more.
usages: List[Literal["encrypt", "decrypt", "sign", 5 more]]Allowed operations with the key. Learn more.
Allowed operations with the key. Learn more.
Key data in JSON Web Key format. Required if format is “jwk”.
A secret value accessible through a binding.
A secret value accessible through a binding.
class WorkersBindingKindSecretKey: …
Algorithm-specific key parameters. Learn more.
format: Literal["raw", "pkcs8", "spki", "jwk"]Data format of the key. Learn more.
Data format of the key. Learn more.
usages: List[Literal["encrypt", "decrypt", "sign", 5 more]]Allowed operations with the key. Learn more.
Allowed operations with the key. Learn more.
Key data in JSON Web Key format. Required if format is “jwk”.
A secret value accessible through a binding.
A secret value accessible through a binding.
class WorkersBindingKindSecretKey: …
Algorithm-specific key parameters. Learn more.
format: Literal["raw", "pkcs8", "spki", "jwk"]Data format of the key. Learn more.
Data format of the key. Learn more.
usages: List[Literal["encrypt", "decrypt", "sign", 5 more]]Allowed operations with the key. Learn more.
Allowed operations with the key. Learn more.
Key data in JSON Web Key format. Required if format is “jwk”.
Dict[str, SecretBulkUpdateResponseItem]Map of secret names to secret metadata for resulting secrets.
Map of secret names to secret metadata for resulting secrets.
class SecretBulkUpdateResponseItemWorkersBindingKindSecretKey: …
Algorithm-specific key parameters. Learn more.
format: Literal["raw", "pkcs8", "spki", "jwk"]Data format of the key. Learn more.
Data format of the key. Learn more.
usages: List[Literal["encrypt", "decrypt", "sign", 5 more]]Allowed operations with the key. Learn more.
Allowed operations with the key. Learn more.
Key data in JSON Web Key format. Required if format is “jwk”.
ScriptsScript And Version Settings
Get Settings
Patch Settings
ModelsExpand Collapse
class ScriptAndVersionSettingGetResponse: …
annotations: Optional[Annotations]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[List[Binding]]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.
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.
class BindingWorkersBindingKindAISearch: …
class BindingWorkersBindingKindAISearchNamespace: …
class BindingWorkersBindingKindDispatchNamespace: …
class BindingWorkersBindingKindInherit: …
class BindingWorkersBindingKindRatelimit: …
class BindingWorkersBindingKindR2Bucket: …
jurisdiction: Optional[Literal["eu", "fedramp", "fedramp-high"]]The jurisdiction of the R2 bucket.
The jurisdiction of the R2 bucket.
class BindingWorkersBindingKindSecretKey: …
Algorithm-specific key parameters. Learn more.
format: Literal["raw", "pkcs8", "spki", "jwk"]Data format of the key. Learn more.
Data format of the key. Learn more.
usages: List[Literal["encrypt", "decrypt", "sign", 5 more]]Allowed operations with the key. Learn more.
Allowed operations with the key. Learn more.
Key data in JSON Web Key format. Required if format is “jwk”.
class BindingWorkersBindingKindWorkflow: …
cache_options: Optional[CacheOptions]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[Dict[str, Exports]]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.
class ExportsWorkersWorkerExport: …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.
class ExportsWorkersDurableObjectExport: …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: Literal["sqlite", "legacy-kv"]Durable Object storage backend. sqlite is the recommended (and
only) backend for new namespaces. legacy-kv is accepted only for
a class whose namespace already exists as KV-backed; the exports
flow never provisions a new legacy-kv namespace.
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.
class ExportsWorkersDurableObjectDeletedExport: …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.
class ExportsWorkersDurableObjectRenamedExport: …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.
class ExportsWorkersDurableObjectTransferredExport: …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.
class ExportsWorkersDurableObjectExpectingTransferExport: …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: Literal["sqlite", "legacy-kv"]Durable Object storage backend. sqlite is the recommended (and
only) backend for new namespaces. legacy-kv is accepted only for
a class whose namespace already exists as KV-backed; the exports
flow never provisions a new legacy-kv namespace.
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[ExportsReconciliation]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: List[ExportsReconciliationInfo]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: Literal["code_class_not_in_exports", "provisioned_class_missing_from_config", "config_export_not_in_code", 30 more]Stable, machine-readable tag identifying which reconciliation
scenario produced an error, warning, or info entry. Clients may
branch on this value instead of parsing message.
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: List[ExportsReconciliationTransferPending]Phase-1 transfer hints recorded on the target side.
Phase-1 transfer hints recorded on the target side.
warnings: List[ExportsReconciliationWarning]Non-blocking warnings. See exports_reconciliation_warning.
Non-blocking warnings. See exports_reconciliation_warning.
scenario: Literal["code_class_not_in_exports", "provisioned_class_missing_from_config", "config_export_not_in_code", 30 more]Stable, machine-readable tag identifying which reconciliation
scenario produced an error, warning, or info entry. Clients may
branch on this value instead of parsing message.
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[Migrations]Migrations to apply for Durable Objects associated with this Worker.
Migrations to apply for Durable Objects associated with this Worker.
class SingleStepMigration: …A single set of migrations to apply.
A single set of migrations to apply.
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.
class MigrationsWorkersMultipleStepMigrations: …
Tag used to verify against the latest migration tag for this Worker. If they don’t match, the upload is rejected.
observability: Optional[Observability]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[ObservabilityLogs]Log settings for the Worker.
Log settings for the Worker.
Whether invocation logs are enabled for the Worker.
traces: Optional[ObservabilityTraces]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[Literal["authenticated", "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[Placement]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.
class PlacementMode: …
Enables Smart Placement.
class ScriptAndVersionSettingEditResponse: …
annotations: Optional[Annotations]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[List[Binding]]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.
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.
class BindingWorkersBindingKindAISearch: …
class BindingWorkersBindingKindAISearchNamespace: …
class BindingWorkersBindingKindDispatchNamespace: …
class BindingWorkersBindingKindInherit: …
class BindingWorkersBindingKindRatelimit: …
class BindingWorkersBindingKindR2Bucket: …
jurisdiction: Optional[Literal["eu", "fedramp", "fedramp-high"]]The jurisdiction of the R2 bucket.
The jurisdiction of the R2 bucket.
class BindingWorkersBindingKindSecretKey: …
Algorithm-specific key parameters. Learn more.
format: Literal["raw", "pkcs8", "spki", "jwk"]Data format of the key. Learn more.
Data format of the key. Learn more.
usages: List[Literal["encrypt", "decrypt", "sign", 5 more]]Allowed operations with the key. Learn more.
Allowed operations with the key. Learn more.
Key data in JSON Web Key format. Required if format is “jwk”.
class BindingWorkersBindingKindWorkflow: …
cache_options: Optional[CacheOptions]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[Dict[str, Exports]]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.
class ExportsWorkersWorkerExport: …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.
class ExportsWorkersDurableObjectExport: …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: Literal["sqlite", "legacy-kv"]Durable Object storage backend. sqlite is the recommended (and
only) backend for new namespaces. legacy-kv is accepted only for
a class whose namespace already exists as KV-backed; the exports
flow never provisions a new legacy-kv namespace.
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.
class ExportsWorkersDurableObjectDeletedExport: …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.
class ExportsWorkersDurableObjectRenamedExport: …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.
class ExportsWorkersDurableObjectTransferredExport: …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.
class ExportsWorkersDurableObjectExpectingTransferExport: …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: Literal["sqlite", "legacy-kv"]Durable Object storage backend. sqlite is the recommended (and
only) backend for new namespaces. legacy-kv is accepted only for
a class whose namespace already exists as KV-backed; the exports
flow never provisions a new legacy-kv namespace.
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[ExportsReconciliation]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: List[ExportsReconciliationInfo]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: Literal["code_class_not_in_exports", "provisioned_class_missing_from_config", "config_export_not_in_code", 30 more]Stable, machine-readable tag identifying which reconciliation
scenario produced an error, warning, or info entry. Clients may
branch on this value instead of parsing message.
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: List[ExportsReconciliationTransferPending]Phase-1 transfer hints recorded on the target side.
Phase-1 transfer hints recorded on the target side.
warnings: List[ExportsReconciliationWarning]Non-blocking warnings. See exports_reconciliation_warning.
Non-blocking warnings. See exports_reconciliation_warning.
scenario: Literal["code_class_not_in_exports", "provisioned_class_missing_from_config", "config_export_not_in_code", 30 more]Stable, machine-readable tag identifying which reconciliation
scenario produced an error, warning, or info entry. Clients may
branch on this value instead of parsing message.
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[Migrations]Migrations to apply for Durable Objects associated with this Worker.
Migrations to apply for Durable Objects associated with this Worker.
class SingleStepMigration: …A single set of migrations to apply.
A single set of migrations to apply.
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.
class MigrationsWorkersMultipleStepMigrations: …
Tag used to verify against the latest migration tag for this Worker. If they don’t match, the upload is rejected.
observability: Optional[Observability]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[ObservabilityLogs]Log settings for the Worker.
Log settings for the Worker.
Whether invocation logs are enabled for the Worker.
traces: Optional[ObservabilityTraces]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[Literal["authenticated", "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[Placement]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.
class PlacementMode: …
Enables Smart Placement.