API Reference

Workers

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Beta

BetaWorkers

List Workers

workers.beta.workers.list(WorkerListParams**kwargs) -> SyncV4PagePaginationArray[Worker]

GET/accounts/{account_id}/workers/workers

Get Worker

workers.beta.workers.get(strworker_id, WorkerGetParams**kwargs) -> Worker

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

Create Worker

workers.beta.workers.create(WorkerCreateParams**kwargs) -> Worker

POST/accounts/{account_id}/workers/workers

Update Worker

workers.beta.workers.update(strworker_id, WorkerUpdateParams**kwargs) -> Worker

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

Edit Worker

workers.beta.workers.edit(strworker_id, WorkerEditParams**kwargs) -> Worker

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

Delete Worker

workers.beta.workers.delete(strworker_id, WorkerDeleteParams**kwargs) -> WorkerDeleteResponse

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

ModelsExpand Collapse

class Worker: …

id: str

Immutable ID of the Worker.

created_on: datetime

When the Worker was created.

formatdate-time

logpush: bool

Whether logpush is enabled for the Worker.

name: str

Name of the Worker.

observability: Observability

Observability settings for the Worker.

enabled: Optional[bool]

Whether observability is enabled for the Worker.

head_sampling_rate: Optional[float]

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

logs: Optional[ObservabilityLogs]

Log settings for the Worker.

destinations: Optional[List[str]]

A list of destinations where logs will be exported to.

enabled: Optional[bool]

Whether logs are enabled for the Worker.

head_sampling_rate: Optional[float]

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

invocation_logs: Optional[bool]

Whether invocation logs are enabled for the Worker.

persist: Optional[bool]

Whether log persistence is enabled for the Worker.

traces: Optional[ObservabilityTraces]

Trace settings for the Worker.

destinations: Optional[List[str]]

A list of destinations where traces will be exported to.

enabled: Optional[bool]

Whether traces are enabled for the Worker.

head_sampling_rate: Optional[float]

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

persist: Optional[bool]

Whether trace persistence is enabled for the Worker.

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.

One of the following:

"authenticated"

"accept"

references: References

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

dispatch_namespace_outbounds: List[ReferencesDispatchNamespaceOutbound]

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

namespace_id: str

ID of the dispatch namespace.

namespace_name: str

Name of the dispatch namespace.

worker_id: str

ID of the Worker using the dispatch namespace.

worker_name: str

Name of the Worker using the dispatch namespace.

domains: List[ReferencesDomain]

Custom domains connected to the Worker.

id: str

ID of the custom domain.

certificate_id: str

ID of the TLS certificate issued for the custom domain.

hostname: str

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

zone_id: str

ID of the zone.

zone_name: str

Name of the zone.

durable_objects: List[ReferencesDurableObject]

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

namespace_id: str

ID of the Durable Object namespace being used.

namespace_name: str

Name of the Durable Object namespace being used.

worker_id: str

ID of the Worker using the Durable Object implementation.

worker_name: str

Name of the Worker using the Durable Object implementation.

queues: List[ReferencesQueue]

Queues that send messages to the Worker.

queue_consumer_id: str

ID of the queue consumer configuration.

queue_id: str

ID of the queue.

queue_name: str

Name of the queue.

workers: List[ReferencesWorker]

Other Workers that reference the Worker using service bindings.

id: str

ID of the referencing Worker.

name: str

Name of the referencing Worker.

subdomain: Subdomain

Subdomain settings for the Worker.

enabled: Optional[bool]

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

previews_enabled: Optional[bool]

Whether preview URLs are enabled for the Worker.

tags: List[str]

Tags associated with the Worker.

tail_consumers: List[TailConsumer]

Other Workers that should consume logs from the Worker.

name: str

Name of the consumer Worker.

updated_on: datetime

When the Worker was most recently updated.

formatdate-time

deployed_on: Optional[datetime]

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

formatdate-time

class WorkerDeleteResponse: …

errors: List[Error]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[ErrorSource]

pointer: Optional[str]

messages: List[Message]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[MessageSource]

pointer: Optional[str]

success: Literal[true]

Whether the API call was successful.

BetaWorkersVersions

List Versions

workers.beta.workers.versions.list(strworker_id, VersionListParams**kwargs) -> SyncV4PagePaginationArray[Version]

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

Get Version

workers.beta.workers.versions.get(strversion_id, VersionGetParams**kwargs) -> Version

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

Create Version

workers.beta.workers.versions.create(strworker_id, VersionCreateParams**kwargs) -> Version

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

Delete Version

workers.beta.workers.versions.delete(strversion_id, VersionDeleteParams**kwargs) -> VersionDeleteResponse

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

ModelsExpand Collapse

class Version: …

id: str

Version identifier.

formatuuid

created_on: datetime

When the version was created.

formatdate-time

number: int

The integer version number, starting from one.

urls: List[str]

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

annotations: Optional[Annotations]

Metadata about the version.

workers_message: Optional[str]

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

maxLength1000

workers_tag: Optional[str]

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

maxLength100

workers_triggered_by: Optional[str]

Operation that triggered the creation of the version.

assets: Optional[Assets]

Configuration for assets within a Worker.

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

config: Optional[AssetsConfig]

Configuration for assets within a Worker.

html_handling: Optional[Literal["auto-trailing-slash", "force-trailing-slash", "drop-trailing-slash", "none"]]

Determines the redirects and rewrites of requests for HTML content.

One of the following:

"auto-trailing-slash"

"force-trailing-slash"

"drop-trailing-slash"

"none"

not_found_handling: Optional[Literal["none", "404-page", "single-page-application"]]

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

One of the following:

"none"

"404-page"

"single-page-application"

run_worker_first: Optional[Union[List[str], bool, null]]

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

One of the following:

List[str]

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

bool

Enables routing to always invoke the Worker script ahead of all requests. When true, this is equivalent to ["/*"] in the string array version of this field.

jwt: Optional[str]

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

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.

One of the following:

class BindingWorkersBindingKindAI: …

name: str

A JavaScript variable name for the binding.

type: Literal["ai"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindAISearch: …

instance_name: str

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

name: str

A JavaScript variable name for the binding.

type: Literal["ai_search"]

The kind of resource that the binding provides.

namespace: Optional[str]

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

class BindingWorkersBindingKindAISearchNamespace: …

name: str

A JavaScript variable name for the binding.

namespace: str

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

type: Literal["ai_search_namespace"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindMessaging: …

name: str

A JavaScript variable name for the binding.

namespace: str

The Messaging namespace to bind to.

type: Literal["messaging"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindAnalyticsEngine: …

dataset: str

The name of the dataset to bind to.

name: str

A JavaScript variable name for the binding.

type: Literal["analytics_engine"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindAssets: …

name: str

A JavaScript variable name for the binding.

type: Literal["assets"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindBrowser: …

name: str

A JavaScript variable name for the binding.

type: Literal["browser"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindD1: …

database_id: str

Identifier of the D1 database to bind to.

name: str

A JavaScript variable name for the binding.

type: Literal["d1"]

The kind of resource that the binding provides.

Deprecatedid: Optional[str]

This property has been renamed to database_id.

Identifier of the D1 database to bind to.

class BindingWorkersBindingKindDataBlob: …

name: str

A JavaScript variable name for the binding.

part: str

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

Deprecatedtype: Literal["data_blob"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindDispatchNamespace: …

name: str

A JavaScript variable name for the binding.

namespace: str

The name of the dispatch namespace.

type: Literal["dispatch_namespace"]

The kind of resource that the binding provides.

outbound: Optional[BindingWorkersBindingKindDispatchNamespaceOutbound]

Outbound worker.

params: Optional[List[BindingWorkersBindingKindDispatchNamespaceOutboundParam]]

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

name: str

Name of the parameter.

worker: Optional[BindingWorkersBindingKindDispatchNamespaceOutboundWorker]

Outbound worker.

entrypoint: Optional[str]

Entrypoint to invoke on the outbound worker.

environment: Optional[str]

Environment of the outbound worker.

service: Optional[str]

Name of the outbound worker.

class BindingWorkersBindingKindDurableObjectNamespace: …

name: str

A JavaScript variable name for the binding.

type: Literal["durable_object_namespace"]

The kind of resource that the binding provides.

class_name: Optional[str]

The exported class name of the Durable Object.

dispatch_namespace: Optional[str]

The dispatch namespace the Durable Object script belongs to.

environment: Optional[str]

The environment of the script_name to bind to.

namespace_id: Optional[str]

Namespace identifier tag.

maxLength32

script_name: Optional[str]

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

class BindingWorkersBindingKindHyperdrive: …

id: str

Identifier of the Hyperdrive connection to bind to.

name: str

A JavaScript variable name for the binding.

type: Literal["hyperdrive"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindInherit: …

name: str

The name of the inherited binding.

type: Literal["inherit"]

The kind of resource that the binding provides.

old_name: Optional[str]

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

version_id: Optional[str]

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

class BindingWorkersBindingKindImages: …

name: str

A JavaScript variable name for the binding.

type: Literal["images"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindJson: …

json: object

JSON data to use.

name: str

A JavaScript variable name for the binding.

type: Literal["json"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindKVNamespace: …

name: str

A JavaScript variable name for the binding.

namespace_id: str

Namespace identifier tag.

maxLength32

type: Literal["kv_namespace"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindMedia: …

name: str

A JavaScript variable name for the binding.

type: Literal["media"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindMTLSCertificate: …

certificate_id: str

Identifier of the certificate to bind to.

name: str

A JavaScript variable name for the binding.

type: Literal["mtls_certificate"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindPlainText: …

name: str

A JavaScript variable name for the binding.

text: str

The text value to use.

type: Literal["plain_text"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindPipelines: …

name: str

A JavaScript variable name for the binding.

pipeline: str

Name of the Pipeline to bind to.

type: Literal["pipelines"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindQueue: …

name: str

A JavaScript variable name for the binding.

queue_name: str

Name of the Queue to bind to.

type: Literal["queue"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindRatelimit: …

name: str

A JavaScript variable name for the binding.

namespace_id: str

Identifier of the rate limit namespace to bind to.

simple: BindingWorkersBindingKindRatelimitSimple

The rate limit configuration.

limit: float

The limit (requests per period).

period: int

The period in seconds.

mitigation_timeout: Optional[int]

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

type: Literal["ratelimit"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindR2Bucket: …

bucket_name: str

R2 bucket to bind to.

name: str

A JavaScript variable name for the binding.

type: Literal["r2_bucket"]

The kind of resource that the binding provides.

jurisdiction: Optional[Literal["eu", "fedramp", "fedramp-high"]]

The jurisdiction of the R2 bucket.

One of the following:

"eu"

"fedramp"

"fedramp-high"

class BindingWorkersBindingKindSecretText: …

name: str

A JavaScript variable name for the binding.

text: str

The secret value to use.

type: Literal["secret_text"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindSendEmail: …

name: str

A JavaScript variable name for the binding.

type: Literal["send_email"]

The kind of resource that the binding provides.

allowed_destination_addresses: Optional[List[str]]

List of allowed destination addresses.

allowed_sender_addresses: Optional[List[str]]

List of allowed sender addresses.

destination_address: Optional[str]

Destination address for the email.

formatemail

class BindingWorkersBindingKindService: …

name: str

A JavaScript variable name for the binding.

service: str

Name of Worker to bind to.

type: Literal["service"]

The kind of resource that the binding provides.

entrypoint: Optional[str]

Entrypoint to invoke on the target Worker.

environment: Optional[str]

Optional environment if the Worker utilizes one.

class BindingWorkersBindingKindTextBlob: …

name: str

A JavaScript variable name for the binding.

part: str

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

Deprecatedtype: Literal["text_blob"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindVectorize: …

index_name: str

Name of the Vectorize index to bind to.

name: str

A JavaScript variable name for the binding.

type: Literal["vectorize"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindVersionMetadata: …

name: str

A JavaScript variable name for the binding.

type: Literal["version_metadata"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindSecretsStoreSecret: …

name: str

A JavaScript variable name for the binding.

secret_name: str

Name of the secret in the store.

store_id: str

ID of the store containing the secret.

type: Literal["secrets_store_secret"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindFlagship: …

app_id: str

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

maxLength128

name: str

A JavaScript variable name for the binding.

type: Literal["flagship"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindSecretKey: …

algorithm: object

Algorithm-specific key parameters. Learn more.

format: Literal["raw", "pkcs8", "spki", "jwk"]

Data format of the key. Learn more.

One of the following:

"raw"

"pkcs8"

"spki"

"jwk"

name: str

A JavaScript variable name for the binding.

type: Literal["secret_key"]

The kind of resource that the binding provides.

usages: List[Literal["encrypt", "decrypt", "sign", 5 more]]

Allowed operations with the key. Learn more.

One of the following:

"encrypt"

"decrypt"

"sign"

"verify"

"deriveKey"

"deriveBits"

"wrapKey"

"unwrapKey"

key_base64: Optional[str]

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

key_jwk: Optional[object]

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

class BindingWorkersBindingKindWorkflow: …

name: str

A JavaScript variable name for the binding.

type: Literal["workflow"]

The kind of resource that the binding provides.

workflow_name: str

Name of the Workflow to bind to.

class_name: Optional[str]

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

script_name: Optional[str]

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

class BindingWorkersBindingKindWasmModule: …

name: str

A JavaScript variable name for the binding.

part: str

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

Deprecatedtype: Literal["wasm_module"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindVPCService: …

name: str

A JavaScript variable name for the binding.

service_id: str

Identifier of the VPC service to bind to.

type: Literal["vpc_service"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindVPCNetwork: …

name: str

A JavaScript variable name for the binding.

type: Literal["vpc_network"]

The kind of resource that the binding provides.

network_id: Optional[str]

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

tunnel_id: Optional[str]

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

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.

enabled: bool

Whether caching is enabled for this Worker.

cross_version_cache: Optional[bool]

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

compatibility_date: Optional[str]

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

compatibility_flags: Optional[List[str]]

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

containers: Optional[List[Container]]

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

class_name: str

Select which Durable Object class should get this container attached.

exports: Optional[Dict[str, Exports]]

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

One of the following:

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.

type: Literal["worker"]

Marks this entry as a Worker entrypoint export.

cache: Optional[ExportsWorkersWorkerExportCache]

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

enabled: bool

Whether caching is enabled for this entrypoint.

state: Optional[Literal["created"]]

Live export. May be omitted; defaults to created.

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.

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.

One of the following:

"sqlite"

"legacy-kv"

type: Literal["durable-object"]

Marks this entry as a Durable Object export.

container: Optional[str]

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

maxLength128

state: Optional[Literal["created"]]

Live export. May be omitted; defaults to created.

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.

state: Literal["deleted"]

Tombstone that deletes the namespace.

type: Literal["durable-object"]

Marks this entry as a Durable Object export.

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.

renamed_to: str

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

maxLength128

state: Literal["renamed"]

Tombstone that renames the namespace’s class.

type: Literal["durable-object"]

Marks this entry as a Durable Object export.

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.

state: Literal["transferred"]

Tombstone that transfers the namespace to another script.

transferred_to: str

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

maxLength128

type: Literal["durable-object"]

Marks this entry as a Durable Object export.

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.

state: Literal["expecting-transfer"]

Target side of a two-phase transfer.

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.

One of the following:

"sqlite"

"legacy-kv"

transfer_from: str

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

maxLength128

type: Literal["durable-object"]

Marks this entry as a Durable Object export.

container: Optional[str]

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

maxLength128

exports_reconciliation: 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.

created: List[str]

Class names for which a new namespace was provisioned.

deleted: List[str]

Class names whose namespace was deleted by a deleted tombstone.

info: List[ExportsReconciliationInfo]

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

class_: str

The class name the info entry is about.

message: str

Human-readable explanation.

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.

One of the following:

"code_class_not_in_exports"

"provisioned_class_missing_from_config"

"config_export_not_in_code"

"config_references_nonexistent_class"

"orphaned_provisioned_namespace"

"storage_type_mismatch"

"free_tier_requires_sqlite"

"invalid_export"

"tombstone_delete_class_still_in_code"

"tombstone_delete_blocked_by_external_bindings"

"tombstone_renamed_to_occupied"

"transferred_pending_not_found"

"transferred_target_missing"

"transferred_target_mismatch"

"phase_one_transfer_source_missing"

"phase_one_transfer_source_namespace_missing"

"phase_one_transfer_target_class_provisioned"

"phase_one_transfer_after_commit_mismatch"

"phase_one_transfer_duplicate"

"phase_one_transfer_target_in_dispatch_namespace"

"phase_one_transfer_source_in_dispatch_namespace"

"transferred_source_in_dispatch_namespace"

"transferred_target_in_dispatch_namespace"

"container_undeclared_reference"

"container_class_not_durable_object"

"container_wiring_inconsistent"

"container_multiple_durable_objects"

"transfer_container_parity_mismatch"

"transfer_container_parity_mismatch_on_commit"

"tombstone_class_still_in_code"

"stale_tombstone"

"transfer_receive_already_applied"

"transfer_receive_cleanup_complete"

namespace_id: Optional[str]

The provisioned namespace the entry relates to, when applicable.

formatuuid

referencing_scripts: Optional[List[str]]

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

removable_entries: List[str]

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

renamed: List[ExportsReconciliationRenamed]

Applied renamed tombstones.

from_: str

The original (source) class name.

to: str

The new class name (renamed_to).

transfer_pending: List[ExportsReconciliationTransferPending]

Phase-1 transfer hints recorded on the target side.

class_: str

The target-side class name awaiting transfer.

from_: str

The source script the namespace will be transferred from.

transferred: List[ExportsReconciliationTransferred]

Committed transferred tombstones (phase-2).

class_: str

The source class name that was transferred.

phase: Literal["committed"]

The transfer phase. Currently always committed.

to: str

The destination script that now owns the namespace.

updated: List[str]

Class names whose provisioned namespace was mutated in place.

warnings: List[ExportsReconciliationWarning]

Non-blocking warnings. See exports_reconciliation_warning.

class_: str

The class name the warning is about.

message: str

Human-readable explanation of the 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.

One of the following:

"code_class_not_in_exports"

"provisioned_class_missing_from_config"

"config_export_not_in_code"

"config_references_nonexistent_class"

"orphaned_provisioned_namespace"

"storage_type_mismatch"

"free_tier_requires_sqlite"

"invalid_export"

"tombstone_delete_class_still_in_code"

"tombstone_delete_blocked_by_external_bindings"

"tombstone_renamed_to_occupied"

"transferred_pending_not_found"

"transferred_target_missing"

"transferred_target_mismatch"

"phase_one_transfer_source_missing"

"phase_one_transfer_source_namespace_missing"

"phase_one_transfer_target_class_provisioned"

"phase_one_transfer_after_commit_mismatch"

"phase_one_transfer_duplicate"

"phase_one_transfer_target_in_dispatch_namespace"

"phase_one_transfer_source_in_dispatch_namespace"

"transferred_source_in_dispatch_namespace"

"transferred_target_in_dispatch_namespace"

"container_undeclared_reference"

"container_class_not_durable_object"

"container_wiring_inconsistent"

"container_multiple_durable_objects"

"transfer_container_parity_mismatch"

"transfer_container_parity_mismatch_on_commit"

"tombstone_class_still_in_code"

"stale_tombstone"

"transfer_receive_already_applied"

"transfer_receive_cleanup_complete"

namespace_id: Optional[str]

The provisioned namespace the warning relates to, when applicable.

formatuuid

limits: Optional[Limits]

Resource limits enforced at runtime.

cpu_ms: Optional[int]

CPU time limit in milliseconds.

subrequests: Optional[int]

Subrequest limit per request.

main_module: Optional[str]

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

migration_tag: Optional[str]

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

migrations: Optional[Migrations]

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

One of the following:

class SingleStepMigration: …

A single set of migrations to apply.

deleted_classes: Optional[List[str]]

A list of classes to delete Durable Object namespaces from.

new_classes: Optional[List[str]]

A list of classes to create Durable Object namespaces from.

new_sqlite_classes: Optional[List[str]]

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

new_tag: Optional[str]

Tag to set as the latest migration tag.

old_tag: Optional[str]

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

renamed_classes: Optional[List[RenamedClass]]

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

from_: Optional[str]

to: Optional[str]

transferred_classes: Optional[List[TransferredClass]]

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

from_: Optional[str]

from_script: Optional[str]

to: Optional[str]

class MigrationsWorkersMultipleStepMigrations: …

new_tag: Optional[str]

Tag to set as the latest migration tag.

old_tag: Optional[str]

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

steps: Optional[List[MigrationStep]]

Migrations to apply in order.

deleted_classes: Optional[List[str]]

A list of classes to delete Durable Object namespaces from.

new_classes: Optional[List[str]]

A list of classes to create Durable Object namespaces from.

new_sqlite_classes: Optional[List[str]]

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

renamed_classes: Optional[List[RenamedClass]]

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

from_: Optional[str]

to: Optional[str]

transferred_classes: Optional[List[TransferredClass]]

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

from_: Optional[str]

from_script: Optional[str]

to: Optional[str]

modules: Optional[List[Module]]

Code, sourcemaps, and other content used at runtime.

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

content_base64: str

The base64-encoded module content.

formatbyte

content_type: str

The content type of the module.

name: str

The name of the module.

package_dependencies: Optional[List[PackageDependency]]

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

installed_version: str

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

name: str

The npm package name.

package_json_version: str

The version constraint as written in package.json.

placement: Optional[Placement]

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

One of the following:

class PlacementMode: …

mode: Literal["smart"]

Enables Smart Placement.

class PlacementRegion: …

region: str

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

class PlacementHostname: …

hostname: str

HTTP hostname for targeted placement.

class PlacementHost: …

host: str

TCP host and port for targeted placement.

class PlacementUnionMember4: …

mode: Literal["targeted"]

Targeted placement mode.

region: str

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

class PlacementUnionMember5: …

hostname: str

HTTP hostname for targeted placement.

mode: Literal["targeted"]

Targeted placement mode.

class PlacementUnionMember6: …

host: str

TCP host and port for targeted placement.

mode: Literal["targeted"]

Targeted placement mode.

class PlacementUnionMember7: …

mode: Literal["targeted"]

Targeted placement mode.

target: List[PlacementUnionMember7Target]

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

One of the following:

class PlacementUnionMember7TargetRegion: …

region: str

Cloud region in format ‘provider:region’.

class PlacementUnionMember7TargetHostname: …

hostname: str

HTTP hostname for targeted placement.

class PlacementUnionMember7TargetHost: …

host: str

TCP host:port for targeted placement.

source: Optional[str]

The client used to create the version.

startup_time_ms: Optional[int]

Time in milliseconds spent on Worker startup.

Deprecatedusage_model: Optional[Literal["standard", "bundled", "unbound"]]

Usage model for the version.

One of the following:

"standard"

"bundled"

"unbound"

class VersionDeleteResponse: …

errors: List[Error]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[ErrorSource]

pointer: Optional[str]

messages: List[Message]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[MessageSource]

pointer: Optional[str]

success: Literal[true]

Whether the API call was successful.