--- title: Scripts --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Workers](https://developers.cloudflare.com/api/python/resources/workers) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Scripts ##### [List Worker Scripts](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/methods/list) workers.scripts.list(ScriptListParams\*\*kwargs) -> SyncSinglePage\[[ScriptListResponse]()] GET/accounts/{account\_id}/workers/scripts ##### [Search Worker Scripts](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/methods/search) workers.scripts.search(ScriptSearchParams\*\*kwargs) -> [ScriptSearchResponse]() GET/accounts/{account\_id}/workers/scripts-search ##### [Download Worker Script](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/methods/get) workers.scripts.get(strscript\_name, ScriptGetParams\*\*kwargs) -> [ScriptGetResponse]() GET/accounts/{account\_id}/workers/scripts/{script\_name} ##### [Upload Worker Module](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/methods/update) workers.scripts.update(strscript\_name, ScriptUpdateParams\*\*kwargs) -> [ScriptUpdateResponse]() PUT/accounts/{account\_id}/workers/scripts/{script\_name} ##### [Delete Worker](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/methods/delete) workers.scripts.delete(strscript\_name, ScriptDeleteParams\*\*kwargs) -> object DELETE/accounts/{account\_id}/workers/scripts/{script\_name} ##### ModelsExpand Collapse
class Script: … id: Optional\[str] The name used to identify the script. Link to this property
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. Link to this property 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. Link to this property
Link to this property 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. Link to this property 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. Link to this property created\_on: Optional\[datetime] When the script was created. formatdate-time Link to this property etag: Optional\[str] Hashed script content, can be used in a If-None-Match header when updating. Link to this property
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. 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. Link to this property
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. Link to this property
Link to this property state: Optional\[Literal\["created"]] Live export. May be omitted; defaults to created. Link to this property
Link to this property
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" Link to this property "legacy-kv" Link to this property
Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property 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 Link to this property state: Optional\[Literal\["created"]] Live export. May be omitted; defaults to created. Link to this property
Link to this property
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. Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property
Link to this property
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 Link to this property state: Literal\["renamed"] Tombstone that renames the namespace’s class. Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property
Link to this property
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. Link to this property 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 Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property
Link to this property
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. Link to this property
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" Link to this property "legacy-kv" Link to this property
Link to this property 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 Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property 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 Link to this property
Link to this property
Link to this property handlers: Optional\[List\[str]] The names of handlers exported as part of the default export. Link to this property has\_assets: Optional\[bool] Whether a Worker contains assets. Link to this property has\_modules: Optional\[bool] Whether a Worker contains modules. Link to this property last\_deployed\_from: Optional\[str] The client most recently used to deploy this Worker. Link to this property logpush: Optional\[bool] Whether Logpush is turned on for the Worker. Link to this property migration\_tag: Optional\[str] The tag of the Durable Object migration that was most recently applied for this Worker. Link to this property modified\_on: Optional\[datetime] When the script was last modified. formatdate-time Link to this property
named\_handlers: Optional\[List\[NamedHandler]] Named exports, such as Durable Object class implementations and named entrypoints. handlers: Optional\[List\[str]] The names of handlers exported as part of the named export. Link to this property name: Optional\[str] The name of the export. Link to this property
Link to this property
observability: Optional\[Observability] Observability settings for the Worker. enabled: bool Whether observability is enabled for the Worker. Link to this property head\_sampling\_rate: Optional\[float] The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1. Link to this property
issues: Optional\[ObservabilityIssues] Real-time Issues settings for the Worker. enabled: Optional\[bool] Whether real-time Issues are enabled for the Worker. Link to this property
Link to this property
logs: Optional\[ObservabilityLogs] Log settings for the Worker. enabled: bool Whether logs are enabled for the Worker. Link to this property invocation\_logs: bool Whether invocation logs are enabled for the Worker. Link to this property destinations: Optional\[List\[str]] A list of destinations where logs will be exported to. Link to this property head\_sampling\_rate: Optional\[float] The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1. Link to this property persist: Optional\[bool] Whether log persistence is enabled for the Worker. Link to this property
Link to this property redact\_query\_string: Optional\[bool] Whether query strings are removed from request URLs in logs and traces. Link to this property
traces: Optional\[ObservabilityTraces] Trace settings for the Worker. destinations: Optional\[List\[str]] A list of destinations where traces will be exported to. Link to this property enabled: Optional\[bool] Whether traces are enabled for the Worker. Link to this property head\_sampling\_rate: Optional\[float] The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1. Link to this property persist: Optional\[bool] Whether trace persistence is enabled for the Worker. Link to this property
propagation\_policy: Optional\[Literal\["authenticated", "accept"]] Controls how inbound trace context (traceparent/tracestate) headers on incoming requests are handled. “authenticated” honors inbound trace context only when accompanied by a valid trace auth token. “accept” unconditionally accepts inbound trace context. Requires the trace propagation feature to be enabled. Returns null when the trace propagation feature is not enabled for the account. One of the following: "authenticated" Link to this property "accept" Link to this property
Link to this property
Link to this property
Link to this property
placement: Optional\[Placement] Configuration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host. One of the following:
class PlacementUnionMember0: … mode: Literal\["smart"] Enables Smart Placement. Link to this property last\_analyzed\_at: Optional\[datetime] The last time the script was analyzed for Smart Placement. formatdate-time Link to this property
status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
Link to this property
class PlacementUnionMember1: … region: str Cloud region for targeted placement in format ‘provider:region’. Link to this property last\_analyzed\_at: Optional\[datetime] The last time the script was analyzed for Smart Placement. formatdate-time Link to this property
status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
Link to this property
class PlacementUnionMember2: … hostname: str HTTP hostname for targeted placement. Link to this property last\_analyzed\_at: Optional\[datetime] The last time the script was analyzed for Smart Placement. formatdate-time Link to this property
status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
Link to this property
class PlacementUnionMember3: … host: str TCP host and port for targeted placement. Link to this property last\_analyzed\_at: Optional\[datetime] The last time the script was analyzed for Smart Placement. formatdate-time Link to this property
status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
Link to this property
class PlacementUnionMember4: … mode: Literal\["targeted"] Targeted placement mode. Link to this property region: str Cloud region for targeted placement in format ‘provider:region’. Link to this property last\_analyzed\_at: Optional\[datetime] The last time the script was analyzed for Smart Placement. formatdate-time Link to this property
status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
Link to this property
class PlacementUnionMember5: … hostname: str HTTP hostname for targeted placement. Link to this property mode: Literal\["targeted"] Targeted placement mode. Link to this property last\_analyzed\_at: Optional\[datetime] The last time the script was analyzed for Smart Placement. formatdate-time Link to this property
status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
Link to this property
class PlacementUnionMember6: … host: str TCP host and port for targeted placement. Link to this property mode: Literal\["targeted"] Targeted placement mode. Link to this property last\_analyzed\_at: Optional\[datetime] The last time the script was analyzed for Smart Placement. formatdate-time Link to this property
status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
Link to this property
class PlacementUnionMember7: … mode: Literal\["targeted"] Targeted placement mode. Link to this property
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’. Link to this property
Link to this property
class PlacementUnionMember7TargetHostname: … hostname: str HTTP hostname for targeted placement. Link to this property
Link to this property
class PlacementUnionMember7TargetHost: … host: str TCP host:port for targeted placement. Link to this property
Link to this property
Link to this property last\_analyzed\_at: Optional\[datetime] The last time the script was analyzed for Smart Placement. formatdate-time Link to this property
status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
Link to this property
Link to this property
Deprecatedplacement\_mode: Optional\[Literal\["smart", "targeted"]] Configuration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host. One of the following: "smart" Link to this property "targeted" Link to this property
Link to this property
Deprecatedplacement\_status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property tag: Optional\[str] The immutable ID of the script. Link to this property tags: Optional\[List\[str]] Tags associated with the Worker. Link to this property
tail\_consumers: Optional\[List\[ConsumerScript]] List of Workers that will consume logs from the attached Worker. service: str Name of Worker that is to be the consumer. Link to this property environment: Optional\[str] Optional environment if the Worker utilizes one. Link to this property namespace: Optional\[str] Optional dispatch namespace the script belongs to. Link to this property
Link to this property
usage\_model: Optional\[Literal\["standard", "bundled", "unbound"]] Usage model for the Worker invocations. One of the following: "standard" Link to this property "bundled" Link to this property "unbound" Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts%20%3E%20(model)%20script%20%3E%20(schema)>)
class ScriptSetting: … logpush: Optional\[bool] Whether Logpush is turned on for the Worker. Link to this property
observability: Optional\[Observability] Observability settings for the Worker. enabled: bool Whether observability is enabled for the Worker. Link to this property head\_sampling\_rate: Optional\[float] The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1. Link to this property
issues: Optional\[ObservabilityIssues] Real-time Issues settings for the Worker. enabled: Optional\[bool] Whether real-time Issues are enabled for the Worker. Link to this property
Link to this property
logs: Optional\[ObservabilityLogs] Log settings for the Worker. enabled: bool Whether logs are enabled for the Worker. Link to this property invocation\_logs: bool Whether invocation logs are enabled for the Worker. Link to this property destinations: Optional\[List\[str]] A list of destinations where logs will be exported to. Link to this property head\_sampling\_rate: Optional\[float] The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1. Link to this property persist: Optional\[bool] Whether log persistence is enabled for the Worker. Link to this property
Link to this property redact\_query\_string: Optional\[bool] Whether query strings are removed from request URLs in logs and traces. Link to this property
traces: Optional\[ObservabilityTraces] Trace settings for the Worker. destinations: Optional\[List\[str]] A list of destinations where traces will be exported to. Link to this property enabled: Optional\[bool] Whether traces are enabled for the Worker. Link to this property head\_sampling\_rate: Optional\[float] The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1. Link to this property persist: Optional\[bool] Whether trace persistence is enabled for the Worker. Link to this property
propagation\_policy: Optional\[Literal\["authenticated", "accept"]] Controls how inbound trace context (traceparent/tracestate) headers on incoming requests are handled. “authenticated” honors inbound trace context only when accompanied by a valid trace auth token. “accept” unconditionally accepts inbound trace context. Requires the trace propagation feature to be enabled. Returns null when the trace propagation feature is not enabled for the account. One of the following: "authenticated" Link to this property "accept" Link to this property
Link to this property
Link to this property
Link to this property tags: Optional\[List\[str]] Tags associated with the Worker. Link to this property
tail\_consumers: Optional\[List\[ConsumerScript]] List of Workers that will consume logs from the attached Worker. service: str Name of Worker that is to be the consumer. Link to this property environment: Optional\[str] Optional environment if the Worker utilizes one. Link to this property namespace: Optional\[str] Optional dispatch namespace the script belongs to. Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts%20%3E%20(model)%20script_setting%20%3E%20(schema)>)
class ScriptListResponse: … id: Optional\[str] The name used to identify the script. Link to this property
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. Link to this property 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. Link to this property
Link to this property 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. Link to this property 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. Link to this property created\_on: Optional\[datetime] When the script was created. formatdate-time Link to this property etag: Optional\[str] Hashed script content, can be used in a If-None-Match header when updating. Link to this property
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. 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. Link to this property
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. Link to this property
Link to this property state: Optional\[Literal\["created"]] Live export. May be omitted; defaults to created. Link to this property
Link to this property
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" Link to this property "legacy-kv" Link to this property
Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property 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 Link to this property state: Optional\[Literal\["created"]] Live export. May be omitted; defaults to created. Link to this property
Link to this property
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. Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property
Link to this property
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 Link to this property state: Literal\["renamed"] Tombstone that renames the namespace’s class. Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property
Link to this property
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. Link to this property 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 Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property
Link to this property
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. Link to this property
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" Link to this property "legacy-kv" Link to this property
Link to this property 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 Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property 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 Link to this property
Link to this property
Link to this property handlers: Optional\[List\[str]] The names of handlers exported as part of the default export. Link to this property has\_assets: Optional\[bool] Whether a Worker contains assets. Link to this property has\_modules: Optional\[bool] Whether a Worker contains modules. Link to this property last\_deployed\_from: Optional\[str] The client most recently used to deploy this Worker. Link to this property logpush: Optional\[bool] Whether Logpush is turned on for the Worker. Link to this property migration\_tag: Optional\[str] The tag of the Durable Object migration that was most recently applied for this Worker. Link to this property modified\_on: Optional\[datetime] When the script was last modified. formatdate-time Link to this property
named\_handlers: Optional\[List\[NamedHandler]] Named exports, such as Durable Object class implementations and named entrypoints. handlers: Optional\[List\[str]] The names of handlers exported as part of the named export. Link to this property name: Optional\[str] The name of the export. Link to this property
Link to this property
observability: Optional\[Observability] Observability settings for the Worker. enabled: bool Whether observability is enabled for the Worker. Link to this property head\_sampling\_rate: Optional\[float] The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1. Link to this property
issues: Optional\[ObservabilityIssues] Real-time Issues settings for the Worker. enabled: Optional\[bool] Whether real-time Issues are enabled for the Worker. Link to this property
Link to this property
logs: Optional\[ObservabilityLogs] Log settings for the Worker. enabled: bool Whether logs are enabled for the Worker. Link to this property invocation\_logs: bool Whether invocation logs are enabled for the Worker. Link to this property destinations: Optional\[List\[str]] A list of destinations where logs will be exported to. Link to this property head\_sampling\_rate: Optional\[float] The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1. Link to this property persist: Optional\[bool] Whether log persistence is enabled for the Worker. Link to this property
Link to this property redact\_query\_string: Optional\[bool] Whether query strings are removed from request URLs in logs and traces. Link to this property
traces: Optional\[ObservabilityTraces] Trace settings for the Worker. destinations: Optional\[List\[str]] A list of destinations where traces will be exported to. Link to this property enabled: Optional\[bool] Whether traces are enabled for the Worker. Link to this property head\_sampling\_rate: Optional\[float] The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1. Link to this property persist: Optional\[bool] Whether trace persistence is enabled for the Worker. Link to this property
propagation\_policy: Optional\[Literal\["authenticated", "accept"]] Controls how inbound trace context (traceparent/tracestate) headers on incoming requests are handled. “authenticated” honors inbound trace context only when accompanied by a valid trace auth token. “accept” unconditionally accepts inbound trace context. Requires the trace propagation feature to be enabled. Returns null when the trace propagation feature is not enabled for the account. One of the following: "authenticated" Link to this property "accept" Link to this property
Link to this property
Link to this property
Link to this property
placement: Optional\[Placement] Configuration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host. One of the following:
class PlacementUnionMember0: … mode: Literal\["smart"] Enables Smart Placement. Link to this property last\_analyzed\_at: Optional\[datetime] The last time the script was analyzed for Smart Placement. formatdate-time Link to this property
status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
Link to this property
class PlacementUnionMember1: … region: str Cloud region for targeted placement in format ‘provider:region’. Link to this property last\_analyzed\_at: Optional\[datetime] The last time the script was analyzed for Smart Placement. formatdate-time Link to this property
status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
Link to this property
class PlacementUnionMember2: … hostname: str HTTP hostname for targeted placement. Link to this property last\_analyzed\_at: Optional\[datetime] The last time the script was analyzed for Smart Placement. formatdate-time Link to this property
status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
Link to this property
class PlacementUnionMember3: … host: str TCP host and port for targeted placement. Link to this property last\_analyzed\_at: Optional\[datetime] The last time the script was analyzed for Smart Placement. formatdate-time Link to this property
status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
Link to this property
class PlacementUnionMember4: … mode: Literal\["targeted"] Targeted placement mode. Link to this property region: str Cloud region for targeted placement in format ‘provider:region’. Link to this property last\_analyzed\_at: Optional\[datetime] The last time the script was analyzed for Smart Placement. formatdate-time Link to this property
status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
Link to this property
class PlacementUnionMember5: … hostname: str HTTP hostname for targeted placement. Link to this property mode: Literal\["targeted"] Targeted placement mode. Link to this property last\_analyzed\_at: Optional\[datetime] The last time the script was analyzed for Smart Placement. formatdate-time Link to this property
status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
Link to this property
class PlacementUnionMember6: … host: str TCP host and port for targeted placement. Link to this property mode: Literal\["targeted"] Targeted placement mode. Link to this property last\_analyzed\_at: Optional\[datetime] The last time the script was analyzed for Smart Placement. formatdate-time Link to this property
status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
Link to this property
class PlacementUnionMember7: … mode: Literal\["targeted"] Targeted placement mode. Link to this property
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’. Link to this property
Link to this property
class PlacementUnionMember7TargetHostname: … hostname: str HTTP hostname for targeted placement. Link to this property
Link to this property
class PlacementUnionMember7TargetHost: … host: str TCP host:port for targeted placement. Link to this property
Link to this property
Link to this property last\_analyzed\_at: Optional\[datetime] The last time the script was analyzed for Smart Placement. formatdate-time Link to this property
status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
Link to this property
Link to this property
Deprecatedplacement\_mode: Optional\[Literal\["smart", "targeted"]] One of the following: "smart" Link to this property "targeted" Link to this property
Link to this property
Deprecatedplacement\_status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
routes: Optional\[List\[Route]] Routes associated with the Worker. id: str Identifier. maxLength32 Link to this property pattern: str Pattern to match incoming requests against. Learn more. Link to this property script: Optional\[str] Name of the script to run if the route matches. Link to this property
Link to this property tag: Optional\[str] The immutable ID of the script. Link to this property tags: Optional\[List\[str]] Tags associated with the Worker. Link to this property
tail\_consumers: Optional\[List\[ConsumerScript]] List of Workers that will consume logs from the attached Worker. service: str Name of Worker that is to be the consumer. Link to this property environment: Optional\[str] Optional environment if the Worker utilizes one. Link to this property namespace: Optional\[str] Optional dispatch namespace the script belongs to. Link to this property
Link to this property
usage\_model: Optional\[Literal\["standard", "bundled", "unbound"]] Usage model for the Worker invocations. One of the following: "standard" Link to this property "bundled" Link to this property "unbound" Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts%20%3E%20(model)%20script_list_response%20%3E%20(schema)>)
List\[ScriptSearchResponseItem] id: str Identifier. maxLength32 Link to this property created\_on: datetime When the script was created. formatdate-time Link to this property modified\_on: datetime When the script was last modified. formatdate-time Link to this property script\_name: str Name of the script. Link to this property environment\_is\_default: Optional\[bool] Whether the environment is the default environment. Link to this property environment\_name: Optional\[str] Name of the environment. Link to this property service\_name: Optional\[str] Name of the service. Link to this property
[Link to this property](<#(resource)%20workers.scripts%20%3E%20(model)%20script_search_response%20%3E%20(schema)>) str [Link to this property](<#(resource)%20workers.scripts%20%3E%20(model)%20script_get_response%20%3E%20(schema)>)
class ScriptUpdateResponse: … startup\_time\_ms: int Link to this property id: Optional\[str] The name used to identify the script. Link to this property
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. Link to this property 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. Link to this property
Link to this property 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. Link to this property 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. Link to this property created\_on: Optional\[datetime] When the script was created. formatdate-time Link to this property entry\_point: Optional\[str] The entry point for the script. Link to this property etag: Optional\[str] Hashed script content, can be used in a If-None-Match header when updating. Link to this property
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. 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. Link to this property
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. Link to this property
Link to this property state: Optional\[Literal\["created"]] Live export. May be omitted; defaults to created. Link to this property
Link to this property
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" Link to this property "legacy-kv" Link to this property
Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property 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 Link to this property state: Optional\[Literal\["created"]] Live export. May be omitted; defaults to created. Link to this property
Link to this property
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. Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property
Link to this property
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 Link to this property state: Literal\["renamed"] Tombstone that renames the namespace’s class. Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property
Link to this property
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. Link to this property 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 Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property
Link to this property
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. Link to this property
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" Link to this property "legacy-kv" Link to this property
Link to this property 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 Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property 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 Link to this property
Link to this property
Link to this property handlers: Optional\[List\[str]] The names of handlers exported as part of the default export. Link to this property has\_assets: Optional\[bool] Whether a Worker contains assets. Link to this property has\_modules: Optional\[bool] Whether a Worker contains modules. Link to this property last\_deployed\_from: Optional\[str] The client most recently used to deploy this Worker. Link to this property logpush: Optional\[bool] Whether Logpush is turned on for the Worker. Link to this property migration\_tag: Optional\[str] The tag of the Durable Object migration that was most recently applied for this Worker. Link to this property modified\_on: Optional\[datetime] When the script was last modified. formatdate-time Link to this property
named\_handlers: Optional\[List\[NamedHandler]] Named exports, such as Durable Object class implementations and named entrypoints. handlers: Optional\[List\[str]] The names of handlers exported as part of the named export. Link to this property name: Optional\[str] The name of the export. Link to this property
Link to this property
observability: Optional\[Observability] Observability settings for the Worker. enabled: bool Whether observability is enabled for the Worker. Link to this property head\_sampling\_rate: Optional\[float] The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1. Link to this property
issues: Optional\[ObservabilityIssues] Real-time Issues settings for the Worker. enabled: Optional\[bool] Whether real-time Issues are enabled for the Worker. Link to this property
Link to this property
logs: Optional\[ObservabilityLogs] Log settings for the Worker. enabled: bool Whether logs are enabled for the Worker. Link to this property invocation\_logs: bool Whether invocation logs are enabled for the Worker. Link to this property destinations: Optional\[List\[str]] A list of destinations where logs will be exported to. Link to this property head\_sampling\_rate: Optional\[float] The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1. Link to this property persist: Optional\[bool] Whether log persistence is enabled for the Worker. Link to this property
Link to this property redact\_query\_string: Optional\[bool] Whether query strings are removed from request URLs in logs and traces. Link to this property
traces: Optional\[ObservabilityTraces] Trace settings for the Worker. destinations: Optional\[List\[str]] A list of destinations where traces will be exported to. Link to this property enabled: Optional\[bool] Whether traces are enabled for the Worker. Link to this property head\_sampling\_rate: Optional\[float] The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1. Link to this property persist: Optional\[bool] Whether trace persistence is enabled for the Worker. Link to this property
propagation\_policy: Optional\[Literal\["authenticated", "accept"]] Controls how inbound trace context (traceparent/tracestate) headers on incoming requests are handled. “authenticated” honors inbound trace context only when accompanied by a valid trace auth token. “accept” unconditionally accepts inbound trace context. Requires the trace propagation feature to be enabled. Returns null when the trace propagation feature is not enabled for the account. One of the following: "authenticated" Link to this property "accept" Link to this property
Link to this property
Link to this property
Link to this property
placement: Optional\[Placement] Configuration for Smart Placement. Specify mode=‘smart’ for Smart Placement, or one of region/hostname/host. One of the following:
class PlacementUnionMember0: … mode: Literal\["smart"] Enables Smart Placement. Link to this property last\_analyzed\_at: Optional\[datetime] The last time the script was analyzed for Smart Placement. formatdate-time Link to this property
status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
Link to this property
class PlacementUnionMember1: … region: str Cloud region for targeted placement in format ‘provider:region’. Link to this property last\_analyzed\_at: Optional\[datetime] The last time the script was analyzed for Smart Placement. formatdate-time Link to this property
status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
Link to this property
class PlacementUnionMember2: … hostname: str HTTP hostname for targeted placement. Link to this property last\_analyzed\_at: Optional\[datetime] The last time the script was analyzed for Smart Placement. formatdate-time Link to this property
status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
Link to this property
class PlacementUnionMember3: … host: str TCP host and port for targeted placement. Link to this property last\_analyzed\_at: Optional\[datetime] The last time the script was analyzed for Smart Placement. formatdate-time Link to this property
status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
Link to this property
class PlacementUnionMember4: … mode: Literal\["targeted"] Targeted placement mode. Link to this property region: str Cloud region for targeted placement in format ‘provider:region’. Link to this property last\_analyzed\_at: Optional\[datetime] The last time the script was analyzed for Smart Placement. formatdate-time Link to this property
status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
Link to this property
class PlacementUnionMember5: … hostname: str HTTP hostname for targeted placement. Link to this property mode: Literal\["targeted"] Targeted placement mode. Link to this property last\_analyzed\_at: Optional\[datetime] The last time the script was analyzed for Smart Placement. formatdate-time Link to this property
status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
Link to this property
class PlacementUnionMember6: … host: str TCP host and port for targeted placement. Link to this property mode: Literal\["targeted"] Targeted placement mode. Link to this property last\_analyzed\_at: Optional\[datetime] The last time the script was analyzed for Smart Placement. formatdate-time Link to this property
status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
Link to this property
class PlacementUnionMember7: … mode: Literal\["targeted"] Targeted placement mode. Link to this property
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’. Link to this property
Link to this property
class PlacementUnionMember7TargetHostname: … hostname: str HTTP hostname for targeted placement. Link to this property
Link to this property
class PlacementUnionMember7TargetHost: … host: str TCP host:port for targeted placement. Link to this property
Link to this property
Link to this property last\_analyzed\_at: Optional\[datetime] The last time the script was analyzed for Smart Placement. formatdate-time Link to this property
status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] Status of Smart Placement. One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property
Link to this property
Link to this property
Deprecatedplacement\_mode: Optional\[Literal\["smart", "targeted"]] One of the following: "smart" Link to this property "targeted" Link to this property
Link to this property
Deprecatedplacement\_status: Optional\[Literal\["SUCCESS", "UNSUPPORTED\_APPLICATION", "INSUFFICIENT\_INVOCATIONS"]] One of the following: "SUCCESS" Link to this property "UNSUPPORTED\_APPLICATION" Link to this property "INSUFFICIENT\_INVOCATIONS" Link to this property
Link to this property tag: Optional\[str] The immutable ID of the script. Link to this property tags: Optional\[List\[str]] Tags associated with the Worker. Link to this property
tail\_consumers: Optional\[List\[ConsumerScript]] List of Workers that will consume logs from the attached Worker. service: str Name of Worker that is to be the consumer. Link to this property environment: Optional\[str] Optional environment if the Worker utilizes one. Link to this property namespace: Optional\[str] Optional dispatch namespace the script belongs to. Link to this property
Link to this property
usage\_model: Optional\[Literal\["standard", "bundled", "unbound"]] Usage model for the Worker invocations. One of the following: "standard" Link to this property "bundled" Link to this property "unbound" Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts%20%3E%20(model)%20script_update_response%20%3E%20(schema)>) #### ScriptsAssets #### ScriptsAssetsUpload ##### [Create Worker Assets Upload Session](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/assets/subresources/upload/methods/create) workers.scripts.assets.upload.create(strscript\_name, UploadCreateParams\*\*kwargs) -> [UploadCreateResponse]() POST/accounts/{account\_id}/workers/scripts/{script\_name}/assets-upload-session ##### ModelsExpand Collapse
class UploadCreateResponse: … buckets: Optional\[List\[List\[str]]] The requests to make to upload assets. Link to this property jwt: Optional\[str] A JWT to use as authentication for uploading assets. Link to this property
[Link to this property](<#(resource)%20workers.scripts.assets.upload%20%3E%20(model)%20upload_create_response%20%3E%20(schema)>) #### ScriptsSubdomain ##### [Get Worker Script Subdomain](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/subdomain/methods/get) workers.scripts.subdomain.get(strscript\_name, SubdomainGetParams\*\*kwargs) -> [SubdomainGetResponse]() GET/accounts/{account\_id}/workers/scripts/{script\_name}/subdomain ##### [Update Worker Script Subdomain](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/subdomain/methods/create) workers.scripts.subdomain.create(strscript\_name, SubdomainCreateParams\*\*kwargs) -> [SubdomainCreateResponse]() POST/accounts/{account\_id}/workers/scripts/{script\_name}/subdomain ##### [Delete Worker Script Subdomain](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/subdomain/methods/delete) workers.scripts.subdomain.delete(strscript\_name, SubdomainDeleteParams\*\*kwargs) -> [SubdomainDeleteResponse]() DELETE/accounts/{account\_id}/workers/scripts/{script\_name}/subdomain ##### ModelsExpand Collapse
class SubdomainGetResponse: … enabled: bool Whether the Worker is available on the workers.dev subdomain. Link to this property previews\_enabled: bool Whether the Worker’s Preview URLs are available on the workers.dev subdomain. Link to this property
[Link to this property](<#(resource)%20workers.scripts.subdomain%20%3E%20(model)%20subdomain_get_response%20%3E%20(schema)>)
class SubdomainCreateResponse: … enabled: bool Whether the Worker is available on the workers.dev subdomain. Link to this property previews\_enabled: bool Whether the Worker’s Preview URLs are available on the workers.dev subdomain. Link to this property
[Link to this property](<#(resource)%20workers.scripts.subdomain%20%3E%20(model)%20subdomain_create_response%20%3E%20(schema)>)
class SubdomainDeleteResponse: … enabled: bool Whether the Worker is available on the workers.dev subdomain. Link to this property previews\_enabled: bool Whether the Worker’s Preview URLs are available on the workers.dev subdomain. Link to this property
[Link to this property](<#(resource)%20workers.scripts.subdomain%20%3E%20(model)%20subdomain_delete_response%20%3E%20(schema)>) #### ScriptsSchedules ##### [Get Worker Script Schedules (Cron Triggers)](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/schedules/methods/get) workers.scripts.schedules.get(strscript\_name, ScheduleGetParams\*\*kwargs) -> [ScheduleGetResponse]() GET/accounts/{account\_id}/workers/scripts/{script\_name}/schedules ##### [Update Worker Script Schedules (Cron Triggers)](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/schedules/methods/update) workers.scripts.schedules.update(strscript\_name, ScheduleUpdateParams\*\*kwargs) -> [ScheduleUpdateResponse]() PUT/accounts/{account\_id}/workers/scripts/{script\_name}/schedules ##### ModelsExpand Collapse
class ScheduleGetResponse: …
schedules: List\[Schedule] cron: str Link to this property created\_on: Optional\[str] Link to this property modified\_on: Optional\[str] Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts.schedules%20%3E%20(model)%20schedule_get_response%20%3E%20(schema)>)
class ScheduleUpdateResponse: …
schedules: List\[Schedule] cron: str Link to this property created\_on: Optional\[str] Link to this property modified\_on: Optional\[str] Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts.schedules%20%3E%20(model)%20schedule_update_response%20%3E%20(schema)>) #### ScriptsTail ##### [List Worker Tails](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/tail/methods/get) workers.scripts.tail.get(strscript\_name, TailGetParams\*\*kwargs) -> [TailGetResponse]() GET/accounts/{account\_id}/workers/scripts/{script\_name}/tails ##### [Start Worker Tail](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/tail/methods/create) workers.scripts.tail.create(strscript\_name, TailCreateParams\*\*kwargs) -> [TailCreateResponse]() POST/accounts/{account\_id}/workers/scripts/{script\_name}/tails ##### [Delete Worker Tail](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/tail/methods/delete) workers.scripts.tail.delete(strid, TailDeleteParams\*\*kwargs) -> [TailDeleteResponse]() DELETE/accounts/{account\_id}/workers/scripts/{script\_name}/tails/{id} ##### ModelsExpand Collapse
class ConsumerScript: … A reference to a script that will consume logs from the attached Worker. service: str Name of Worker that is to be the consumer. Link to this property environment: Optional\[str] Optional environment if the Worker utilizes one. Link to this property namespace: Optional\[str] Optional dispatch namespace the script belongs to. Link to this property
[Link to this property](<#(resource)%20workers.scripts.tail%20%3E%20(model)%20consumer_script%20%3E%20(schema)>)
class TailGetResponse: … id: str Identifier. maxLength32 Link to this property expires\_at: str Link to this property url: str Link to this property
[Link to this property](<#(resource)%20workers.scripts.tail%20%3E%20(model)%20tail_get_response%20%3E%20(schema)>)
class TailCreateResponse: … id: str Identifier. maxLength32 Link to this property expires\_at: str Link to this property url: str Link to this property
[Link to this property](<#(resource)%20workers.scripts.tail%20%3E%20(model)%20tail_create_response%20%3E%20(schema)>)
class TailDeleteResponse: …
errors: List\[Error] code: int minimum1000 Link to this property message: str Link to this property documentation\_url: Optional\[str] Link to this property
source: Optional\[ErrorSource] pointer: Optional\[str] Link to this property
Link to this property
Link to this property
messages: List\[Message] code: int minimum1000 Link to this property message: str Link to this property documentation\_url: Optional\[str] Link to this property
source: Optional\[MessageSource] pointer: Optional\[str] Link to this property
Link to this property
Link to this property success: Literal\[true] Whether the API call was successful. Link to this property
[Link to this property](<#(resource)%20workers.scripts.tail%20%3E%20(model)%20tail_delete_response%20%3E%20(schema)>) #### ScriptsContent ##### [Get Worker Script Content](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/content/methods/get) workers.scripts.content.get(strscript\_name, ContentGetParams\*\*kwargs) -> BinaryResponseContent GET/accounts/{account\_id}/workers/scripts/{script\_name}/content/v2 ##### [Replace Worker Script Content](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/content/methods/update) workers.scripts.content.update(strscript\_name, ContentUpdateParams\*\*kwargs) -> [Script]() PUT/accounts/{account\_id}/workers/scripts/{script\_name}/content #### ScriptsSettings ##### [Get Worker Script Settings](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/settings/methods/get) workers.scripts.settings.get(strscript\_name, SettingGetParams\*\*kwargs) -> [ScriptSetting]() GET/accounts/{account\_id}/workers/scripts/{script\_name}/script-settings ##### [Patch Worker Script Settings](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/settings/methods/edit) workers.scripts.settings.edit(strscript\_name, SettingEditParams\*\*kwargs) -> [ScriptSetting]() PATCH/accounts/{account\_id}/workers/scripts/{script\_name}/script-settings #### ScriptsDeployments ##### [List Worker Deployments](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/deployments/methods/list) workers.scripts.deployments.list(strscript\_name, DeploymentListParams\*\*kwargs) -> SyncV4PagePagination\[[DeploymentListResponse]()] GET/accounts/{account\_id}/workers/scripts/{script\_name}/deployments ##### [Create Worker Deployment](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/deployments/methods/create) workers.scripts.deployments.create(strscript\_name, DeploymentCreateParams\*\*kwargs) -> [Deployment]() POST/accounts/{account\_id}/workers/scripts/{script\_name}/deployments ##### [Get Worker Deployment](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/deployments/methods/get) workers.scripts.deployments.get(strdeployment\_id, DeploymentGetParams\*\*kwargs) -> [Deployment]() GET/accounts/{account\_id}/workers/scripts/{script\_name}/deployments/{deployment\_id} ##### [Delete Worker Deployment](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/deployments/methods/delete) workers.scripts.deployments.delete(strdeployment\_id, DeploymentDeleteParams\*\*kwargs) -> [DeploymentDeleteResponse]() DELETE/accounts/{account\_id}/workers/scripts/{script\_name}/deployments/{deployment\_id} ##### ModelsExpand Collapse
class Deployment: … id: str formatuuid Link to this property created\_on: datetime formatdate-time Link to this property source: str Link to this property strategy: Literal\["percentage"] Link to this property
versions: List\[Version] Worker versions included in this deployment. Each object must contain a version_id UUID and a percentage; percentages across all objects must total 100. In the cf CLI, pass the entire array as one JSON value to --versions, either inline, for example --versions '[{"version_id":"023e105f-2a42-4f8b-a1c1-73f6a2a30c0f","percentage":100}]', or from a JSON file with --versions @versions.json. percentage: float Percentage of traffic served by this version. maximum100 minimum0.01 Link to this property version\_id: str Identifier of the Worker Version. formatuuid Link to this property
Link to this property
annotations: Optional\[Annotations] workers\_message: Optional\[str] Human-readable message about the deployment. Truncated to 1000 bytes if longer. maxLength1000 Link to this property workers\_triggered\_by: Optional\[str] Operation that triggered the creation of the deployment. Link to this property
Link to this property author\_email: Optional\[str] formatemail Link to this property
[Link to this property](<#(resource)%20workers.scripts.deployments%20%3E%20(model)%20deployment%20%3E%20(schema)>)
class DeploymentListResponse: …
deployments: List\[Deployment] id: str formatuuid Link to this property created\_on: datetime formatdate-time Link to this property source: str Link to this property strategy: Literal\["percentage"] Link to this property
versions: List\[Version] Worker versions included in this deployment. Each object must contain a version_id UUID and a percentage; percentages across all objects must total 100. In the cf CLI, pass the entire array as one JSON value to --versions, either inline, for example --versions '[{"version_id":"023e105f-2a42-4f8b-a1c1-73f6a2a30c0f","percentage":100}]', or from a JSON file with --versions @versions.json. percentage: float Percentage of traffic served by this version. maximum100 minimum0.01 Link to this property version\_id: str Identifier of the Worker Version. formatuuid Link to this property
Link to this property
annotations: Optional\[Annotations] workers\_message: Optional\[str] Human-readable message about the deployment. Truncated to 1000 bytes if longer. maxLength1000 Link to this property workers\_triggered\_by: Optional\[str] Operation that triggered the creation of the deployment. Link to this property
Link to this property author\_email: Optional\[str] formatemail Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts.deployments%20%3E%20(model)%20deployment_list_response%20%3E%20(schema)>)
class DeploymentDeleteResponse: …
errors: List\[Error] code: int minimum1000 Link to this property message: str Link to this property documentation\_url: Optional\[str] Link to this property
source: Optional\[ErrorSource] pointer: Optional\[str] Link to this property
Link to this property
Link to this property
messages: List\[Message] code: int minimum1000 Link to this property message: str Link to this property documentation\_url: Optional\[str] Link to this property
source: Optional\[MessageSource] pointer: Optional\[str] Link to this property
Link to this property
Link to this property success: Literal\[true] Whether the API call was successful. Link to this property
[Link to this property](<#(resource)%20workers.scripts.deployments%20%3E%20(model)%20deployment_delete_response%20%3E%20(schema)>) #### ScriptsVersions ##### [List Versions](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/versions/methods/list) workers.scripts.versions.list(strscript\_name, VersionListParams\*\*kwargs) -> SyncV4PagePagination\[[VersionListResponse]()] GET/accounts/{account\_id}/workers/scripts/{script\_name}/versions ##### [Get Worker Script Version](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/versions/methods/get) workers.scripts.versions.get(strversion\_id, VersionGetParams\*\*kwargs) -> [VersionGetResponse]() GET/accounts/{account\_id}/workers/scripts/{script\_name}/versions/{version\_id} ##### [Upload Version](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/versions/methods/create) workers.scripts.versions.create(strscript\_name, VersionCreateParams\*\*kwargs) -> [VersionCreateResponse]() POST/accounts/{account\_id}/workers/scripts/{script\_name}/versions ##### ModelsExpand Collapse
class VersionListResponse: … id: Optional\[str] Unique identifier for the version. Link to this property
metadata: Optional\[Metadata] author\_email: Optional\[str] Email of the user who created the version. Link to this property author\_id: Optional\[str] Identifier of the user who created the version. Link to this property created\_on: Optional\[str] When the version was created. Link to this property has\_preview: Optional\[bool] Whether the version can be previewed. Link to this property modified\_on: Optional\[str] When the version was last modified. Link to this property
source: Optional\[Literal\["unknown", "api", "wrangler", 8 more]] The source of the version upload. One of the following: "unknown" Link to this property "api" Link to this property "wrangler" Link to this property "terraform" Link to this property "dash" Link to this property "cf\_cli" Link to this property "dash\_template" Link to this property "integration" Link to this property "quick\_editor" Link to this property "playground" Link to this property "workersci" Link to this property
Link to this property
Link to this property number: Optional\[float] Sequential version number. Link to this property
[Link to this property](<#(resource)%20workers.scripts.versions%20%3E%20(model)%20version_list_response%20%3E%20(schema)>)
class VersionGetResponse: …
resources: Resources bindings: Optional\[ResourcesBindings] List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings. Link to this property
script: Optional\[ResourcesScript] etag: Optional\[str] Hashed script content Link to this property handlers: Optional\[List\[str]] The names of handlers exported as part of the default export. Link to this property last\_deployed\_from: Optional\[str] The client most recently used to deploy this Worker. Link to this property
named\_handlers: Optional\[List\[ResourcesScriptNamedHandler]] Named exports, such as Durable Object class implementations and named entrypoints. handlers: Optional\[List\[str]] The names of handlers exported as part of the named export. Link to this property name: Optional\[str] The name of the exported class or entrypoint. Link to this property
Link to this property
Link to this property
script\_runtime: Optional\[ResourcesScriptRuntime] Runtime configuration for the Worker. 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. Link to this property compatibility\_flags: Optional\[List\[str]] Flags that enable or disable certain features in the Workers runtime. Link to this property
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. One of the following:
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. type: Literal\["worker"] Marks this entry as a Worker entrypoint export. Link to this property
cache: Optional\[ResourcesScriptRuntimeExportsWorkersWorkerExportCache] 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. Link to this property
Link to this property state: Optional\[Literal\["created"]] Live export. May be omitted; defaults to created. Link to this property
Link to this property
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.
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" Link to this property "legacy-kv" Link to this property
Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property 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 Link to this property state: Optional\[Literal\["created"]] Live export. May be omitted; defaults to created. Link to this property
Link to this property
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. state: Literal\["deleted"] Tombstone that deletes the namespace. Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property
Link to this property
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. 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 Link to this property state: Literal\["renamed"] Tombstone that renames the namespace’s class. Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property
Link to this property
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. state: Literal\["transferred"] Tombstone that transfers the namespace to another script. Link to this property 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 Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property
Link to this property
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. state: Literal\["expecting-transfer"] Target side of a two-phase transfer. Link to this property
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" Link to this property "legacy-kv" Link to this property
Link to this property 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 Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property 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 Link to this property
Link to this property
Link to this property
limits: Optional\[ResourcesScriptRuntimeLimits] Resource limits for the Worker. cpu\_ms: Optional\[int] The amount of CPU time this Worker can use in milliseconds. Link to this property
Link to this property migration\_tag: Optional\[str] The tag of the Durable Object migration that was most recently applied for this Worker. Link to this property
usage\_model: Optional\[Literal\["bundled", "unbound", "standard"]] Usage model for the Worker invocations. One of the following: "bundled" Link to this property "unbound" Link to this property "standard" Link to this property
Link to this property
Link to this property
Link to this property id: Optional\[str] Unique identifier for the version. Link to this property
metadata: Optional\[Metadata] author\_email: Optional\[str] Email of the user who created the version. Link to this property author\_id: Optional\[str] Identifier of the user who created the version. Link to this property created\_on: Optional\[str] When the version was created. Link to this property has\_preview: Optional\[bool] Whether the version can be previewed. Link to this property modified\_on: Optional\[str] When the version was last modified. Link to this property
source: Optional\[Literal\["unknown", "api", "wrangler", 8 more]] The source of the version upload. One of the following: "unknown" Link to this property "api" Link to this property "wrangler" Link to this property "terraform" Link to this property "dash" Link to this property "cf\_cli" Link to this property "dash\_template" Link to this property "integration" Link to this property "quick\_editor" Link to this property "playground" Link to this property "workersci" Link to this property
Link to this property
Link to this property number: Optional\[float] Sequential version number. Link to this property
[Link to this property](<#(resource)%20workers.scripts.versions%20%3E%20(model)%20version_get_response%20%3E%20(schema)>)
class VersionCreateResponse: …
resources: Resources bindings: Optional\[ResourcesBindings] List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings. Link to this property
script: Optional\[ResourcesScript] etag: Optional\[str] Hashed script content Link to this property handlers: Optional\[List\[str]] The names of handlers exported as part of the default export. Link to this property last\_deployed\_from: Optional\[str] The client most recently used to deploy this Worker. Link to this property
named\_handlers: Optional\[List\[ResourcesScriptNamedHandler]] Named exports, such as Durable Object class implementations and named entrypoints. handlers: Optional\[List\[str]] The names of handlers exported as part of the named export. Link to this property name: Optional\[str] The name of the exported class or entrypoint. Link to this property
Link to this property
Link to this property
script\_runtime: Optional\[ResourcesScriptRuntime] Runtime configuration for the Worker. 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. Link to this property compatibility\_flags: Optional\[List\[str]] Flags that enable or disable certain features in the Workers runtime. Link to this property
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. One of the following:
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. type: Literal\["worker"] Marks this entry as a Worker entrypoint export. Link to this property
cache: Optional\[ResourcesScriptRuntimeExportsWorkersWorkerExportCache] 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. Link to this property
Link to this property state: Optional\[Literal\["created"]] Live export. May be omitted; defaults to created. Link to this property
Link to this property
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.
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" Link to this property "legacy-kv" Link to this property
Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property 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 Link to this property state: Optional\[Literal\["created"]] Live export. May be omitted; defaults to created. Link to this property
Link to this property
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. state: Literal\["deleted"] Tombstone that deletes the namespace. Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property
Link to this property
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. 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 Link to this property state: Literal\["renamed"] Tombstone that renames the namespace’s class. Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property
Link to this property
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. state: Literal\["transferred"] Tombstone that transfers the namespace to another script. Link to this property 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 Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property
Link to this property
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. state: Literal\["expecting-transfer"] Target side of a two-phase transfer. Link to this property
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" Link to this property "legacy-kv" Link to this property
Link to this property 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 Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property 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 Link to this property
Link to this property
Link to this property
limits: Optional\[ResourcesScriptRuntimeLimits] Resource limits for the Worker. cpu\_ms: Optional\[int] The amount of CPU time this Worker can use in milliseconds. Link to this property
Link to this property migration\_tag: Optional\[str] The tag of the Durable Object migration that was most recently applied for this Worker. Link to this property
usage\_model: Optional\[Literal\["bundled", "unbound", "standard"]] Usage model for the Worker invocations. One of the following: "bundled" Link to this property "unbound" Link to this property "standard" Link to this property
Link to this property
Link to this property
Link to this property id: Optional\[str] Unique identifier for the version. Link to this property
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. Link to this property deleted: List\[str] Class names whose namespace was deleted by a deleted tombstone. Link to this property
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. Link to this property message: str Human-readable explanation. Link to this property
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" Link to this property "provisioned\_class\_missing\_from\_config" Link to this property "config\_export\_not\_in\_code" Link to this property "config\_references\_nonexistent\_class" Link to this property "orphaned\_provisioned\_namespace" Link to this property "storage\_type\_mismatch" Link to this property "free\_tier\_requires\_sqlite" Link to this property "invalid\_export" Link to this property "tombstone\_delete\_class\_still\_in\_code" Link to this property "tombstone\_delete\_blocked\_by\_external\_bindings" Link to this property "tombstone\_renamed\_to\_occupied" Link to this property "transferred\_pending\_not\_found" Link to this property "transferred\_target\_missing" Link to this property "transferred\_target\_mismatch" Link to this property "phase\_one\_transfer\_source\_missing" Link to this property "phase\_one\_transfer\_source\_namespace\_missing" Link to this property "phase\_one\_transfer\_target\_class\_provisioned" Link to this property "phase\_one\_transfer\_after\_commit\_mismatch" Link to this property "phase\_one\_transfer\_duplicate" Link to this property "phase\_one\_transfer\_target\_in\_dispatch\_namespace" Link to this property "phase\_one\_transfer\_source\_in\_dispatch\_namespace" Link to this property "transferred\_source\_in\_dispatch\_namespace" Link to this property "transferred\_target\_in\_dispatch\_namespace" Link to this property "container\_undeclared\_reference" Link to this property "container\_class\_not\_durable\_object" Link to this property "container\_wiring\_inconsistent" Link to this property "container\_multiple\_durable\_objects" Link to this property "transfer\_container\_parity\_mismatch" Link to this property "transfer\_container\_parity\_mismatch\_on\_commit" Link to this property "tombstone\_class\_still\_in\_code" Link to this property "stale\_tombstone" Link to this property "transfer\_receive\_already\_applied" Link to this property "transfer\_receive\_cleanup\_complete" Link to this property
Link to this property namespace\_id: Optional\[str] The provisioned namespace the entry relates to, when applicable. formatuuid Link to this property 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. Link to this property
Link to this property removable\_entries: List\[str] Source class names whose tombstone entry is now stale and safe to delete from exports (no remaining referencing scripts). Link to this property
renamed: List\[ExportsReconciliationRenamed] Applied renamed tombstones. from\_: str The original (source) class name. Link to this property to: str The new class name (renamed_to). Link to this property
Link to this property
transfer\_pending: List\[ExportsReconciliationTransferPending] Phase-1 transfer hints recorded on the target side. class\_: str The target-side class name awaiting transfer. Link to this property from\_: str The source script the namespace will be transferred from. Link to this property
Link to this property
transferred: List\[ExportsReconciliationTransferred] Committed transferred tombstones (phase-2). class\_: str The source class name that was transferred. Link to this property phase: Literal\["committed"] The transfer phase. Currently always committed. Link to this property to: str The destination script that now owns the namespace. Link to this property
Link to this property updated: List\[str] Class names whose provisioned namespace was mutated in place. Link to this property
warnings: List\[ExportsReconciliationWarning] Non-blocking warnings. See exports_reconciliation_warning. class\_: str The class name the warning is about. Link to this property message: str Human-readable explanation of the warning. Link to this property
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" Link to this property "provisioned\_class\_missing\_from\_config" Link to this property "config\_export\_not\_in\_code" Link to this property "config\_references\_nonexistent\_class" Link to this property "orphaned\_provisioned\_namespace" Link to this property "storage\_type\_mismatch" Link to this property "free\_tier\_requires\_sqlite" Link to this property "invalid\_export" Link to this property "tombstone\_delete\_class\_still\_in\_code" Link to this property "tombstone\_delete\_blocked\_by\_external\_bindings" Link to this property "tombstone\_renamed\_to\_occupied" Link to this property "transferred\_pending\_not\_found" Link to this property "transferred\_target\_missing" Link to this property "transferred\_target\_mismatch" Link to this property "phase\_one\_transfer\_source\_missing" Link to this property "phase\_one\_transfer\_source\_namespace\_missing" Link to this property "phase\_one\_transfer\_target\_class\_provisioned" Link to this property "phase\_one\_transfer\_after\_commit\_mismatch" Link to this property "phase\_one\_transfer\_duplicate" Link to this property "phase\_one\_transfer\_target\_in\_dispatch\_namespace" Link to this property "phase\_one\_transfer\_source\_in\_dispatch\_namespace" Link to this property "transferred\_source\_in\_dispatch\_namespace" Link to this property "transferred\_target\_in\_dispatch\_namespace" Link to this property "container\_undeclared\_reference" Link to this property "container\_class\_not\_durable\_object" Link to this property "container\_wiring\_inconsistent" Link to this property "container\_multiple\_durable\_objects" Link to this property "transfer\_container\_parity\_mismatch" Link to this property "transfer\_container\_parity\_mismatch\_on\_commit" Link to this property "tombstone\_class\_still\_in\_code" Link to this property "stale\_tombstone" Link to this property "transfer\_receive\_already\_applied" Link to this property "transfer\_receive\_cleanup\_complete" Link to this property
Link to this property namespace\_id: Optional\[str] The provisioned namespace the warning relates to, when applicable. formatuuid Link to this property
Link to this property
Link to this property
metadata: Optional\[Metadata] author\_email: Optional\[str] Email of the user who created the version. Link to this property author\_id: Optional\[str] Identifier of the user who created the version. Link to this property created\_on: Optional\[str] When the version was created. Link to this property has\_preview: Optional\[bool] Whether the version can be previewed. Link to this property modified\_on: Optional\[str] When the version was last modified. Link to this property
source: Optional\[Literal\["unknown", "api", "wrangler", 8 more]] The source of the version upload. One of the following: "unknown" Link to this property "api" Link to this property "wrangler" Link to this property "terraform" Link to this property "dash" Link to this property "cf\_cli" Link to this property "dash\_template" Link to this property "integration" Link to this property "quick\_editor" Link to this property "playground" Link to this property "workersci" Link to this property
Link to this property
Link to this property number: Optional\[float] Sequential version number. Link to this property startup\_time\_ms: Optional\[int] Time in milliseconds spent on Worker startup. Link to this property
[Link to this property](<#(resource)%20workers.scripts.versions%20%3E%20(model)%20version_create_response%20%3E%20(schema)>) #### ScriptsSecrets ##### [List secrets bound to a Worker script](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/secrets/methods/list) workers.scripts.secrets.list(strscript\_name, SecretListParams\*\*kwargs) -> SyncSinglePage\[[SecretListResponse]()] GET/accounts/{account\_id}/workers/scripts/{script\_name}/secrets ##### [Get a secret binding](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/secrets/methods/get) workers.scripts.secrets.get(strsecret\_name, SecretGetParams\*\*kwargs) -> [SecretGetResponse]() GET/accounts/{account\_id}/workers/scripts/{script\_name}/secrets/{secret\_name} ##### [Add a secret to a Worker script](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/secrets/methods/update) workers.scripts.secrets.update(strscript\_name, SecretUpdateParams\*\*kwargs) -> [SecretUpdateResponse]() PUT/accounts/{account\_id}/workers/scripts/{script\_name}/secrets ##### [Delete Worker script secret](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/secrets/methods/delete) workers.scripts.secrets.delete(strsecret\_name, SecretDeleteParams\*\*kwargs) -> object DELETE/accounts/{account\_id}/workers/scripts/{script\_name}/secrets/{secret\_name} ##### [Patch multiple Worker script secrets](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/secrets/methods/bulk_update) workers.scripts.secrets.bulk\_update(strscript\_name, SecretBulkUpdateParams\*\*kwargs) -> [SecretBulkUpdateResponse]() PATCH/accounts/{account\_id}/workers/scripts/{script\_name}/secrets-bulk ##### ModelsExpand Collapse
SecretListResponse A secret value accessible through a binding. One of the following:
class WorkersBindingKindSecretText: … name: str A JavaScript variable name for the binding. Link to this property text: str The secret value to use. Link to this property type: Literal\["secret\_text"] The kind of resource that the binding provides. Link to this property
Link to this property
class WorkersBindingKindSecretKey: … algorithm: object Algorithm-specific key parameters. Learn more. Link to this property
format: Literal\["raw", "pkcs8", "spki", "jwk"] Data format of the key. Learn more. One of the following: "raw" Link to this property "pkcs8" Link to this property "spki" Link to this property "jwk" Link to this property
Link to this property name: str A JavaScript variable name for the binding. Link to this property type: Literal\["secret\_key"] The kind of resource that the binding provides. Link to this property
usages: List\[Literal\["encrypt", "decrypt", "sign", 5 more]] Allowed operations with the key. Learn more. One of the following: "encrypt" Link to this property "decrypt" Link to this property "sign" Link to this property "verify" Link to this property "deriveKey" Link to this property "deriveBits" Link to this property "wrapKey" Link to this property "unwrapKey" Link to this property
Link to this property key\_base64: Optional\[str] Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”. Link to this property key\_jwk: Optional\[object] Key data in JSON Web Key format. Required if format is “jwk”. Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts.secrets%20%3E%20(model)%20secret_list_response%20%3E%20(schema)>)
SecretGetResponse A secret value accessible through a binding. One of the following:
class WorkersBindingKindSecretText: … name: str A JavaScript variable name for the binding. Link to this property text: str The secret value to use. Link to this property type: Literal\["secret\_text"] The kind of resource that the binding provides. Link to this property
Link to this property
class WorkersBindingKindSecretKey: … algorithm: object Algorithm-specific key parameters. Learn more. Link to this property
format: Literal\["raw", "pkcs8", "spki", "jwk"] Data format of the key. Learn more. One of the following: "raw" Link to this property "pkcs8" Link to this property "spki" Link to this property "jwk" Link to this property
Link to this property name: str A JavaScript variable name for the binding. Link to this property type: Literal\["secret\_key"] The kind of resource that the binding provides. Link to this property
usages: List\[Literal\["encrypt", "decrypt", "sign", 5 more]] Allowed operations with the key. Learn more. One of the following: "encrypt" Link to this property "decrypt" Link to this property "sign" Link to this property "verify" Link to this property "deriveKey" Link to this property "deriveBits" Link to this property "wrapKey" Link to this property "unwrapKey" Link to this property
Link to this property key\_base64: Optional\[str] Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”. Link to this property key\_jwk: Optional\[object] Key data in JSON Web Key format. Required if format is “jwk”. Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts.secrets%20%3E%20(model)%20secret_get_response%20%3E%20(schema)>)
SecretUpdateResponse A secret value accessible through a binding. One of the following:
class WorkersBindingKindSecretText: … name: str A JavaScript variable name for the binding. Link to this property text: str The secret value to use. Link to this property type: Literal\["secret\_text"] The kind of resource that the binding provides. Link to this property
Link to this property
class WorkersBindingKindSecretKey: … algorithm: object Algorithm-specific key parameters. Learn more. Link to this property
format: Literal\["raw", "pkcs8", "spki", "jwk"] Data format of the key. Learn more. One of the following: "raw" Link to this property "pkcs8" Link to this property "spki" Link to this property "jwk" Link to this property
Link to this property name: str A JavaScript variable name for the binding. Link to this property type: Literal\["secret\_key"] The kind of resource that the binding provides. Link to this property
usages: List\[Literal\["encrypt", "decrypt", "sign", 5 more]] Allowed operations with the key. Learn more. One of the following: "encrypt" Link to this property "decrypt" Link to this property "sign" Link to this property "verify" Link to this property "deriveKey" Link to this property "deriveBits" Link to this property "wrapKey" Link to this property "unwrapKey" Link to this property
Link to this property key\_base64: Optional\[str] Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”. Link to this property key\_jwk: Optional\[object] Key data in JSON Web Key format. Required if format is “jwk”. Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts.secrets%20%3E%20(model)%20secret_update_response%20%3E%20(schema)>)
Dict\[str, SecretBulkUpdateResponseItem] Map of secret names to secret metadata for resulting secrets. One of the following:
class SecretBulkUpdateResponseItemWorkersBindingKindSecretText: … name: str A JavaScript variable name for the binding. Link to this property text: str The secret value to use. Link to this property type: Literal\["secret\_text"] The kind of resource that the binding provides. Link to this property
Link to this property
class SecretBulkUpdateResponseItemWorkersBindingKindSecretKey: … algorithm: object Algorithm-specific key parameters. Learn more. Link to this property
format: Literal\["raw", "pkcs8", "spki", "jwk"] Data format of the key. Learn more. One of the following: "raw" Link to this property "pkcs8" Link to this property "spki" Link to this property "jwk" Link to this property
Link to this property name: str A JavaScript variable name for the binding. Link to this property type: Literal\["secret\_key"] The kind of resource that the binding provides. Link to this property
usages: List\[Literal\["encrypt", "decrypt", "sign", 5 more]] Allowed operations with the key. Learn more. One of the following: "encrypt" Link to this property "decrypt" Link to this property "sign" Link to this property "verify" Link to this property "deriveKey" Link to this property "deriveBits" Link to this property "wrapKey" Link to this property "unwrapKey" Link to this property
Link to this property key\_base64: Optional\[str] Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”. Link to this property key\_jwk: Optional\[object] Key data in JSON Web Key format. Required if format is “jwk”. Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts.secrets%20%3E%20(model)%20secret_bulk_update_response%20%3E%20(schema)>) #### ScriptsScript And Version Settings ##### [Get Worker Script and Version Settings](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/script_and_version_settings/methods/get) workers.scripts.script\_and\_version\_settings.get(strscript\_name, ScriptAndVersionSettingGetParams\*\*kwargs) -> [ScriptAndVersionSettingGetResponse]() GET/accounts/{account\_id}/workers/scripts/{script\_name}/settings ##### [Patch Worker Script and Version Settings](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts/subresources/script_and_version_settings/methods/edit) workers.scripts.script\_and\_version\_settings.edit(strscript\_name, ScriptAndVersionSettingEditParams\*\*kwargs) -> [ScriptAndVersionSettingEditResponse]() PATCH/accounts/{account\_id}/workers/scripts/{script\_name}/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. workers\_message: Optional\[str] Human-readable message about the version. Truncated to 1000 bytes if longer. maxLength1000 Link to this property workers\_tag: Optional\[str] User-provided identifier for the version. Maximum 100 bytes. maxLength100 Link to this property workers\_triggered\_by: Optional\[str] Operation that triggered the creation of the version. This is read-only and set by the server. Link to this property
Link to this property
bindings: Optional\[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. Link to this property type: Literal\["ai"] The kind of resource that the binding provides. Link to this property
Link to this property
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. Link to this property name: str A JavaScript variable name for the binding. Link to this property type: Literal\["ai\_search"] The kind of resource that the binding provides. Link to this property 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. Link to this property
Link to this property
class BindingWorkersBindingKindAISearchNamespace: … name: str A JavaScript variable name for the binding. Link to this property 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. Link to this property type: Literal\["ai\_search\_namespace"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindMessaging: … name: str A JavaScript variable name for the binding. Link to this property namespace: str The Messaging namespace to bind to. Link to this property type: Literal\["messaging"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindAnalyticsEngine: … dataset: str The name of the dataset to bind to. Link to this property name: str A JavaScript variable name for the binding. Link to this property type: Literal\["analytics\_engine"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindArtifacts: … name: str A JavaScript variable name for the binding. Link to this property namespace: str The Artifacts namespace exposed to the Worker in the Worker’s account. Must be 2-63 characters, start with an ASCII alphanumeric character, contain only ASCII alphanumeric characters, dots, underscores, and hyphens, and must not end with a hyphen. The namespace does not need to be created before binding it. maxLength63 minLength2 Link to this property type: Literal\["artifacts"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindAssets: … name: str A JavaScript variable name for the binding. Link to this property type: Literal\["assets"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindBrowser: … name: str A JavaScript variable name for the binding. Link to this property type: Literal\["browser"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindD1: … database\_id: str Identifier of the D1 database to bind to. Link to this property name: str A JavaScript variable name for the binding. Link to this property type: Literal\["d1"] The kind of resource that the binding provides. Link to this property Deprecatedid: Optional\[str] This property has been renamed to database_id. Identifier of the D1 database to bind to. Link to this property
Link to this property
class BindingWorkersBindingKindDataBlob: … name: str A JavaScript variable name for the binding. Link to this property part: str The name of the file containing the data content. Only accepted for service worker syntax Workers. Link to this property Deprecatedtype: Literal\["data\_blob"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindDispatchNamespace: … name: str A JavaScript variable name for the binding. Link to this property namespace: str The name of the dispatch namespace. Link to this property type: Literal\["dispatch\_namespace"] The kind of resource that the binding provides. Link to this property
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. Link to this property
Link to this property
worker: Optional\[BindingWorkersBindingKindDispatchNamespaceOutboundWorker] Outbound worker. entrypoint: Optional\[str] Entrypoint to invoke on the outbound worker. Link to this property environment: Optional\[str] Environment of the outbound worker. Link to this property service: Optional\[str] Name of the outbound worker. Link to this property
Link to this property
Link to this property
Link to this property
class BindingWorkersBindingKindDurableObjectNamespace: … name: str A JavaScript variable name for the binding. Link to this property type: Literal\["durable\_object\_namespace"] The kind of resource that the binding provides. Link to this property class\_name: Optional\[str] The exported class name of the Durable Object. Link to this property dispatch\_namespace: Optional\[str] The dispatch namespace the Durable Object script belongs to. Link to this property environment: Optional\[str] The environment of the script\_name to bind to. Link to this property namespace\_id: Optional\[str] Namespace identifier tag. maxLength32 Link to this property script\_name: Optional\[str] The script where the Durable Object is defined, if it is external to this Worker. Link to this property
Link to this property
class BindingWorkersBindingKindHyperdrive: … id: str Identifier of the Hyperdrive connection to bind to. Link to this property name: str A JavaScript variable name for the binding. Link to this property type: Literal\["hyperdrive"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindInherit: … name: str The name of the inherited binding. Link to this property type: Literal\["inherit"] The kind of resource that the binding provides. Link to this property 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. Link to this property 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. Link to this property
Link to this property
class BindingWorkersBindingKindImages: … name: str A JavaScript variable name for the binding. Link to this property type: Literal\["images"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindJson: … json: object JSON data to use. Link to this property name: str A JavaScript variable name for the binding. Link to this property type: Literal\["json"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindKVNamespace: … name: str A JavaScript variable name for the binding. Link to this property namespace\_id: str Namespace identifier tag. maxLength32 Link to this property type: Literal\["kv\_namespace"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindMedia: … name: str A JavaScript variable name for the binding. Link to this property type: Literal\["media"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindMTLSCertificate: … certificate\_id: str Identifier of the certificate to bind to. Link to this property name: str A JavaScript variable name for the binding. Link to this property type: Literal\["mtls\_certificate"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindPlainText: … name: str A JavaScript variable name for the binding. Link to this property text: str The text value to use. Link to this property type: Literal\["plain\_text"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindPipelines: … name: str A JavaScript variable name for the binding. Link to this property pipeline: str Name of the Pipeline to bind to. Link to this property type: Literal\["pipelines"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindK2: … A K2 stream binding. Available only to accounts enabled for K2. name: str A JavaScript variable name for the binding. Link to this property stream: str ID of a K2 stream owned by the account deploying the Worker. Link to this property type: Literal\["k2"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindQueue: … name: str A JavaScript variable name for the binding. Link to this property queue\_name: str Name of the Queue to bind to. Link to this property type: Literal\["queue"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindRatelimit: … name: str A JavaScript variable name for the binding. Link to this property namespace\_id: str Identifier of the rate limit namespace to bind to. Link to this property
simple: BindingWorkersBindingKindRatelimitSimple The rate limit configuration. limit: float The limit (requests per period). Link to this property period: int The period in seconds. Link to this property 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. Link to this property
Link to this property type: Literal\["ratelimit"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindR2Bucket: … bucket\_name: str R2 bucket to bind to. Link to this property name: str A JavaScript variable name for the binding. Link to this property type: Literal\["r2\_bucket"] The kind of resource that the binding provides. Link to this property
jurisdiction: Optional\[Literal\["eu", "fedramp", "fedramp-high", "us"]] The jurisdiction of the R2 bucket. One of the following: "eu" Link to this property "fedramp" Link to this property "fedramp-high" Link to this property "us" Link to this property
Link to this property
Link to this property
class BindingWorkersBindingKindSecretText: … name: str A JavaScript variable name for the binding. Link to this property text: str The secret value to use. Link to this property type: Literal\["secret\_text"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindSendEmail: … name: str A JavaScript variable name for the binding. Link to this property type: Literal\["send\_email"] The kind of resource that the binding provides. Link to this property allowed\_destination\_addresses: Optional\[List\[str]] List of allowed destination addresses. Link to this property allowed\_sender\_addresses: Optional\[List\[str]] List of allowed sender addresses. Link to this property destination\_address: Optional\[str] Destination address for the email. formatemail Link to this property
Link to this property
class BindingWorkersBindingKindService: … name: str A JavaScript variable name for the binding. Link to this property service: str Name of Worker to bind to. Link to this property type: Literal\["service"] The kind of resource that the binding provides. Link to this property entrypoint: Optional\[str] Entrypoint to invoke on the target Worker. Link to this property environment: Optional\[str] Optional environment if the Worker utilizes one. Link to this property
Link to this property
class BindingWorkersBindingKindTextBlob: … name: str A JavaScript variable name for the binding. Link to this property part: str The name of the file containing the text content. Only accepted for service worker syntax Workers. Link to this property Deprecatedtype: Literal\["text\_blob"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindVectorize: … index\_name: str Name of the Vectorize index to bind to. Link to this property name: str A JavaScript variable name for the binding. Link to this property type: Literal\["vectorize"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindVersionMetadata: … name: str A JavaScript variable name for the binding. Link to this property type: Literal\["version\_metadata"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindSecretsStoreSecret: … name: str A JavaScript variable name for the binding. Link to this property secret\_name: str Name of the secret in the store. Link to this property store\_id: str ID of the store containing the secret. Link to this property type: Literal\["secrets\_store\_secret"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindFlagship: … app\_id: str ID of the Flagship app to bind to for feature flag evaluation. maxLength128 Link to this property name: str A JavaScript variable name for the binding. Link to this property type: Literal\["flagship"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindSecretKey: … algorithm: object Algorithm-specific key parameters. Learn more. Link to this property
format: Literal\["raw", "pkcs8", "spki", "jwk"] Data format of the key. Learn more. One of the following: "raw" Link to this property "pkcs8" Link to this property "spki" Link to this property "jwk" Link to this property
Link to this property name: str A JavaScript variable name for the binding. Link to this property type: Literal\["secret\_key"] The kind of resource that the binding provides. Link to this property
usages: List\[Literal\["encrypt", "decrypt", "sign", 5 more]] Allowed operations with the key. Learn more. One of the following: "encrypt" Link to this property "decrypt" Link to this property "sign" Link to this property "verify" Link to this property "deriveKey" Link to this property "deriveBits" Link to this property "wrapKey" Link to this property "unwrapKey" Link to this property
Link to this property key\_base64: Optional\[str] Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”. Link to this property key\_jwk: Optional\[object] Key data in JSON Web Key format. Required if format is “jwk”. Link to this property
Link to this property
class BindingWorkersBindingKindWorkflow: … name: str A JavaScript variable name for the binding. Link to this property type: Literal\["workflow"] The kind of resource that the binding provides. Link to this property workflow\_name: str Name of the Workflow to bind to. Link to this property class\_name: Optional\[str] Class name of the Workflow. Should only be provided if the Workflow belongs to this script. Link to this property script\_name: Optional\[str] Script name that contains the Workflow. If not provided, defaults to this script name. Link to this property
Link to this property
class BindingWorkersBindingKindWasmModule: … name: str A JavaScript variable name for the binding. Link to this property part: str The name of the file containing the WebAssembly module content. Only accepted for service worker syntax Workers. Link to this property Deprecatedtype: Literal\["wasm\_module"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindVPCService: … name: str A JavaScript variable name for the binding. Link to this property service\_id: str Identifier of the VPC service to bind to. Link to this property type: Literal\["vpc\_service"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindVPCNetwork: … name: str A JavaScript variable name for the binding. Link to this property type: Literal\["vpc\_network"] The kind of resource that the binding provides. Link to this property identity: Optional\[Literal\["runtime-email-alpha"]] Enables Gateway identity for the binding. Requires network\_id to be “cf1:network” and cannot be combined with tunnel\_id. Link to this property network\_id: Optional\[str] Identifier of the network to bind to. Only “cf1:network” is currently supported. Mutually exclusive with tunnel\_id. Link to this property tunnel\_id: Optional\[str] UUID of the Cloudflare Tunnel to bind to. Mutually exclusive with network\_id. Link to this property
Link to this property
Link to this property
cache\_options: Optional\[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. Link to this property 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. Link to this property
Link to this property 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. Link to this property 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. Link to this property
exports: Optional\[Dict\[str, Exports]] Declarative exports for the Worker. Worker entrypoint entries (type: worker) carry cache configuration for that entrypoint. 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. Link to this property
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. Link to this property
Link to this property state: Optional\[Literal\["created"]] Live export. May be omitted; defaults to created. Link to this property
Link to this property
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" Link to this property "legacy-kv" Link to this property
Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property 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 Link to this property state: Optional\[Literal\["created"]] Live export. May be omitted; defaults to created. Link to this property
Link to this property
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. Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property
Link to this property
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 Link to this property state: Literal\["renamed"] Tombstone that renames the namespace’s class. Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property
Link to this property
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. Link to this property 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 Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property
Link to this property
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. Link to this property
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" Link to this property "legacy-kv" Link to this property
Link to this property 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 Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property 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 Link to this property
Link to this property
Link to this property
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. Link to this property deleted: List\[str] Class names whose namespace was deleted by a deleted tombstone. Link to this property
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. Link to this property message: str Human-readable explanation. Link to this property
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" Link to this property "provisioned\_class\_missing\_from\_config" Link to this property "config\_export\_not\_in\_code" Link to this property "config\_references\_nonexistent\_class" Link to this property "orphaned\_provisioned\_namespace" Link to this property "storage\_type\_mismatch" Link to this property "free\_tier\_requires\_sqlite" Link to this property "invalid\_export" Link to this property "tombstone\_delete\_class\_still\_in\_code" Link to this property "tombstone\_delete\_blocked\_by\_external\_bindings" Link to this property "tombstone\_renamed\_to\_occupied" Link to this property "transferred\_pending\_not\_found" Link to this property "transferred\_target\_missing" Link to this property "transferred\_target\_mismatch" Link to this property "phase\_one\_transfer\_source\_missing" Link to this property "phase\_one\_transfer\_source\_namespace\_missing" Link to this property "phase\_one\_transfer\_target\_class\_provisioned" Link to this property "phase\_one\_transfer\_after\_commit\_mismatch" Link to this property "phase\_one\_transfer\_duplicate" Link to this property "phase\_one\_transfer\_target\_in\_dispatch\_namespace" Link to this property "phase\_one\_transfer\_source\_in\_dispatch\_namespace" Link to this property "transferred\_source\_in\_dispatch\_namespace" Link to this property "transferred\_target\_in\_dispatch\_namespace" Link to this property "container\_undeclared\_reference" Link to this property "container\_class\_not\_durable\_object" Link to this property "container\_wiring\_inconsistent" Link to this property "container\_multiple\_durable\_objects" Link to this property "transfer\_container\_parity\_mismatch" Link to this property "transfer\_container\_parity\_mismatch\_on\_commit" Link to this property "tombstone\_class\_still\_in\_code" Link to this property "stale\_tombstone" Link to this property "transfer\_receive\_already\_applied" Link to this property "transfer\_receive\_cleanup\_complete" Link to this property
Link to this property namespace\_id: Optional\[str] The provisioned namespace the entry relates to, when applicable. formatuuid Link to this property 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. Link to this property
Link to this property removable\_entries: List\[str] Source class names whose tombstone entry is now stale and safe to delete from exports (no remaining referencing scripts). Link to this property
renamed: List\[ExportsReconciliationRenamed] Applied renamed tombstones. from\_: str The original (source) class name. Link to this property to: str The new class name (renamed_to). Link to this property
Link to this property
transfer\_pending: List\[ExportsReconciliationTransferPending] Phase-1 transfer hints recorded on the target side. class\_: str The target-side class name awaiting transfer. Link to this property from\_: str The source script the namespace will be transferred from. Link to this property
Link to this property
transferred: List\[ExportsReconciliationTransferred] Committed transferred tombstones (phase-2). class\_: str The source class name that was transferred. Link to this property phase: Literal\["committed"] The transfer phase. Currently always committed. Link to this property to: str The destination script that now owns the namespace. Link to this property
Link to this property updated: List\[str] Class names whose provisioned namespace was mutated in place. Link to this property
warnings: List\[ExportsReconciliationWarning] Non-blocking warnings. See exports_reconciliation_warning. class\_: str The class name the warning is about. Link to this property message: str Human-readable explanation of the warning. Link to this property
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" Link to this property "provisioned\_class\_missing\_from\_config" Link to this property "config\_export\_not\_in\_code" Link to this property "config\_references\_nonexistent\_class" Link to this property "orphaned\_provisioned\_namespace" Link to this property "storage\_type\_mismatch" Link to this property "free\_tier\_requires\_sqlite" Link to this property "invalid\_export" Link to this property "tombstone\_delete\_class\_still\_in\_code" Link to this property "tombstone\_delete\_blocked\_by\_external\_bindings" Link to this property "tombstone\_renamed\_to\_occupied" Link to this property "transferred\_pending\_not\_found" Link to this property "transferred\_target\_missing" Link to this property "transferred\_target\_mismatch" Link to this property "phase\_one\_transfer\_source\_missing" Link to this property "phase\_one\_transfer\_source\_namespace\_missing" Link to this property "phase\_one\_transfer\_target\_class\_provisioned" Link to this property "phase\_one\_transfer\_after\_commit\_mismatch" Link to this property "phase\_one\_transfer\_duplicate" Link to this property "phase\_one\_transfer\_target\_in\_dispatch\_namespace" Link to this property "phase\_one\_transfer\_source\_in\_dispatch\_namespace" Link to this property "transferred\_source\_in\_dispatch\_namespace" Link to this property "transferred\_target\_in\_dispatch\_namespace" Link to this property "container\_undeclared\_reference" Link to this property "container\_class\_not\_durable\_object" Link to this property "container\_wiring\_inconsistent" Link to this property "container\_multiple\_durable\_objects" Link to this property "transfer\_container\_parity\_mismatch" Link to this property "transfer\_container\_parity\_mismatch\_on\_commit" Link to this property "tombstone\_class\_still\_in\_code" Link to this property "stale\_tombstone" Link to this property "transfer\_receive\_already\_applied" Link to this property "transfer\_receive\_cleanup\_complete" Link to this property
Link to this property namespace\_id: Optional\[str] The provisioned namespace the warning relates to, when applicable. formatuuid Link to this property
Link to this property
Link to this property
limits: Optional\[Limits] Limits to apply for this Worker. cpu\_ms: Optional\[int] The amount of CPU time this Worker can use in milliseconds. Link to this property subrequests: Optional\[int] The number of subrequests this Worker can make per request. Link to this property
Link to this property logpush: Optional\[bool] Whether Logpush is turned on for the Worker. Link to this property
migrations: Optional\[Migrations] Migrations to apply for Durable Objects associated with this Worker. 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. Link to this property new\_classes: Optional\[List\[str]] A list of classes to create Durable Object namespaces from. Link to this property new\_sqlite\_classes: Optional\[List\[str]] A list of classes to create Durable Object namespaces with SQLite from. Link to this property new\_tag: Optional\[str] Tag to set as the latest migration tag. Link to this property 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. Link to this property
renamed\_classes: Optional\[List\[RenamedClass]] A list of classes with Durable Object namespaces that were renamed. from\_: Optional\[str] Link to this property to: Optional\[str] Link to this property
Link to this property
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] Link to this property from\_script: Optional\[str] Link to this property to: Optional\[str] Link to this property
Link to this property
Link to this property
class MigrationsWorkersMultipleStepMigrations: … new\_tag: Optional\[str] Tag to set as the latest migration tag. Link to this property 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. Link to this property
steps: Optional\[List\[MigrationStep]] Migrations to apply in order. deleted\_classes: Optional\[List\[str]] A list of classes to delete Durable Object namespaces from. Link to this property new\_classes: Optional\[List\[str]] A list of classes to create Durable Object namespaces from. Link to this property new\_sqlite\_classes: Optional\[List\[str]] A list of classes to create Durable Object namespaces with SQLite from. Link to this property
renamed\_classes: Optional\[List\[RenamedClass]] A list of classes with Durable Object namespaces that were renamed. from\_: Optional\[str] Link to this property to: Optional\[str] Link to this property
Link to this property
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] Link to this property from\_script: Optional\[str] Link to this property to: Optional\[str] Link to this property
Link to this property
Link to this property
Link to this property
Link to this property
observability: Optional\[Observability] Observability settings for the Worker. enabled: bool Whether observability is enabled for the Worker. Link to this property head\_sampling\_rate: Optional\[float] The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1. Link to this property
issues: Optional\[ObservabilityIssues] Real-time Issues settings for the Worker. enabled: Optional\[bool] Whether real-time Issues are enabled for the Worker. Link to this property
Link to this property
logs: Optional\[ObservabilityLogs] Log settings for the Worker. enabled: bool Whether logs are enabled for the Worker. Link to this property invocation\_logs: bool Whether invocation logs are enabled for the Worker. Link to this property destinations: Optional\[List\[str]] A list of destinations where logs will be exported to. Link to this property head\_sampling\_rate: Optional\[float] The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1. Link to this property persist: Optional\[bool] Whether log persistence is enabled for the Worker. Link to this property
Link to this property redact\_query\_string: Optional\[bool] Whether query strings are removed from request URLs in logs and traces. Link to this property
traces: Optional\[ObservabilityTraces] Trace settings for the Worker. destinations: Optional\[List\[str]] A list of destinations where traces will be exported to. Link to this property enabled: Optional\[bool] Whether traces are enabled for the Worker. Link to this property head\_sampling\_rate: Optional\[float] The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1. Link to this property persist: Optional\[bool] Whether trace persistence is enabled for the Worker. Link to this property
propagation\_policy: Optional\[Literal\["authenticated", "accept"]] Controls how inbound trace context (traceparent/tracestate) headers on incoming requests are handled. “authenticated” honors inbound trace context only when accompanied by a valid trace auth token. “accept” unconditionally accepts inbound trace context. Requires the trace propagation feature to be enabled. Returns null when the trace propagation feature is not enabled for the account. One of the following: "authenticated" Link to this property "accept" Link to this property
Link to this property
Link to this property
Link to this property
placement: Optional\[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. Link to this property
Link to this property
class PlacementRegion: … region: str Cloud region for targeted placement in format ‘provider:region’. Link to this property
Link to this property
class PlacementHostname: … hostname: str HTTP hostname for targeted placement. Link to this property
Link to this property
class PlacementHost: … host: str TCP host and port for targeted placement. Link to this property
Link to this property
class PlacementUnionMember4: … mode: Literal\["targeted"] Targeted placement mode. Link to this property region: str Cloud region for targeted placement in format ‘provider:region’. Link to this property
Link to this property
class PlacementUnionMember5: … hostname: str HTTP hostname for targeted placement. Link to this property mode: Literal\["targeted"] Targeted placement mode. Link to this property
Link to this property
class PlacementUnionMember6: … host: str TCP host and port for targeted placement. Link to this property mode: Literal\["targeted"] Targeted placement mode. Link to this property
Link to this property
class PlacementUnionMember7: … mode: Literal\["targeted"] Targeted placement mode. Link to this property
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’. Link to this property
Link to this property
class PlacementUnionMember7TargetHostname: … hostname: str HTTP hostname for targeted placement. Link to this property
Link to this property
class PlacementUnionMember7TargetHost: … host: str TCP host:port for targeted placement. Link to this property
Link to this property
Link to this property
Link to this property
Link to this property tags: Optional\[List\[str]] Tags associated with the Worker. Link to this property
tail\_consumers: Optional\[List\[ConsumerScript]] List of Workers that will consume logs from the attached Worker. service: str Name of Worker that is to be the consumer. Link to this property environment: Optional\[str] Optional environment if the Worker utilizes one. Link to this property namespace: Optional\[str] Optional dispatch namespace the script belongs to. Link to this property
Link to this property
usage\_model: Optional\[Literal\["standard", "bundled", "unbound"]] Usage model for the Worker invocations. One of the following: "standard" Link to this property "bundled" Link to this property "unbound" Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts.script_and_version_settings%20%3E%20(model)%20script_and_version_setting_get_response%20%3E%20(schema)>)
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. workers\_message: Optional\[str] Human-readable message about the version. Truncated to 1000 bytes if longer. maxLength1000 Link to this property workers\_tag: Optional\[str] User-provided identifier for the version. Maximum 100 bytes. maxLength100 Link to this property workers\_triggered\_by: Optional\[str] Operation that triggered the creation of the version. This is read-only and set by the server. Link to this property
Link to this property
bindings: Optional\[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. Link to this property type: Literal\["ai"] The kind of resource that the binding provides. Link to this property
Link to this property
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. Link to this property name: str A JavaScript variable name for the binding. Link to this property type: Literal\["ai\_search"] The kind of resource that the binding provides. Link to this property 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. Link to this property
Link to this property
class BindingWorkersBindingKindAISearchNamespace: … name: str A JavaScript variable name for the binding. Link to this property 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. Link to this property type: Literal\["ai\_search\_namespace"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindMessaging: … name: str A JavaScript variable name for the binding. Link to this property namespace: str The Messaging namespace to bind to. Link to this property type: Literal\["messaging"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindAnalyticsEngine: … dataset: str The name of the dataset to bind to. Link to this property name: str A JavaScript variable name for the binding. Link to this property type: Literal\["analytics\_engine"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindArtifacts: … name: str A JavaScript variable name for the binding. Link to this property namespace: str The Artifacts namespace exposed to the Worker in the Worker’s account. Must be 2-63 characters, start with an ASCII alphanumeric character, contain only ASCII alphanumeric characters, dots, underscores, and hyphens, and must not end with a hyphen. The namespace does not need to be created before binding it. maxLength63 minLength2 Link to this property type: Literal\["artifacts"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindAssets: … name: str A JavaScript variable name for the binding. Link to this property type: Literal\["assets"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindBrowser: … name: str A JavaScript variable name for the binding. Link to this property type: Literal\["browser"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindD1: … database\_id: str Identifier of the D1 database to bind to. Link to this property name: str A JavaScript variable name for the binding. Link to this property type: Literal\["d1"] The kind of resource that the binding provides. Link to this property Deprecatedid: Optional\[str] This property has been renamed to database_id. Identifier of the D1 database to bind to. Link to this property
Link to this property
class BindingWorkersBindingKindDataBlob: … name: str A JavaScript variable name for the binding. Link to this property part: str The name of the file containing the data content. Only accepted for service worker syntax Workers. Link to this property Deprecatedtype: Literal\["data\_blob"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindDispatchNamespace: … name: str A JavaScript variable name for the binding. Link to this property namespace: str The name of the dispatch namespace. Link to this property type: Literal\["dispatch\_namespace"] The kind of resource that the binding provides. Link to this property
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. Link to this property
Link to this property
worker: Optional\[BindingWorkersBindingKindDispatchNamespaceOutboundWorker] Outbound worker. entrypoint: Optional\[str] Entrypoint to invoke on the outbound worker. Link to this property environment: Optional\[str] Environment of the outbound worker. Link to this property service: Optional\[str] Name of the outbound worker. Link to this property
Link to this property
Link to this property
Link to this property
class BindingWorkersBindingKindDurableObjectNamespace: … name: str A JavaScript variable name for the binding. Link to this property type: Literal\["durable\_object\_namespace"] The kind of resource that the binding provides. Link to this property class\_name: Optional\[str] The exported class name of the Durable Object. Link to this property dispatch\_namespace: Optional\[str] The dispatch namespace the Durable Object script belongs to. Link to this property environment: Optional\[str] The environment of the script\_name to bind to. Link to this property namespace\_id: Optional\[str] Namespace identifier tag. maxLength32 Link to this property script\_name: Optional\[str] The script where the Durable Object is defined, if it is external to this Worker. Link to this property
Link to this property
class BindingWorkersBindingKindHyperdrive: … id: str Identifier of the Hyperdrive connection to bind to. Link to this property name: str A JavaScript variable name for the binding. Link to this property type: Literal\["hyperdrive"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindInherit: … name: str The name of the inherited binding. Link to this property type: Literal\["inherit"] The kind of resource that the binding provides. Link to this property 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. Link to this property 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. Link to this property
Link to this property
class BindingWorkersBindingKindImages: … name: str A JavaScript variable name for the binding. Link to this property type: Literal\["images"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindJson: … json: object JSON data to use. Link to this property name: str A JavaScript variable name for the binding. Link to this property type: Literal\["json"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindKVNamespace: … name: str A JavaScript variable name for the binding. Link to this property namespace\_id: str Namespace identifier tag. maxLength32 Link to this property type: Literal\["kv\_namespace"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindMedia: … name: str A JavaScript variable name for the binding. Link to this property type: Literal\["media"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindMTLSCertificate: … certificate\_id: str Identifier of the certificate to bind to. Link to this property name: str A JavaScript variable name for the binding. Link to this property type: Literal\["mtls\_certificate"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindPlainText: … name: str A JavaScript variable name for the binding. Link to this property text: str The text value to use. Link to this property type: Literal\["plain\_text"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindPipelines: … name: str A JavaScript variable name for the binding. Link to this property pipeline: str Name of the Pipeline to bind to. Link to this property type: Literal\["pipelines"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindK2: … A K2 stream binding. Available only to accounts enabled for K2. name: str A JavaScript variable name for the binding. Link to this property stream: str ID of a K2 stream owned by the account deploying the Worker. Link to this property type: Literal\["k2"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindQueue: … name: str A JavaScript variable name for the binding. Link to this property queue\_name: str Name of the Queue to bind to. Link to this property type: Literal\["queue"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindRatelimit: … name: str A JavaScript variable name for the binding. Link to this property namespace\_id: str Identifier of the rate limit namespace to bind to. Link to this property
simple: BindingWorkersBindingKindRatelimitSimple The rate limit configuration. limit: float The limit (requests per period). Link to this property period: int The period in seconds. Link to this property 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. Link to this property
Link to this property type: Literal\["ratelimit"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindR2Bucket: … bucket\_name: str R2 bucket to bind to. Link to this property name: str A JavaScript variable name for the binding. Link to this property type: Literal\["r2\_bucket"] The kind of resource that the binding provides. Link to this property
jurisdiction: Optional\[Literal\["eu", "fedramp", "fedramp-high", "us"]] The jurisdiction of the R2 bucket. One of the following: "eu" Link to this property "fedramp" Link to this property "fedramp-high" Link to this property "us" Link to this property
Link to this property
Link to this property
class BindingWorkersBindingKindSecretText: … name: str A JavaScript variable name for the binding. Link to this property text: str The secret value to use. Link to this property type: Literal\["secret\_text"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindSendEmail: … name: str A JavaScript variable name for the binding. Link to this property type: Literal\["send\_email"] The kind of resource that the binding provides. Link to this property allowed\_destination\_addresses: Optional\[List\[str]] List of allowed destination addresses. Link to this property allowed\_sender\_addresses: Optional\[List\[str]] List of allowed sender addresses. Link to this property destination\_address: Optional\[str] Destination address for the email. formatemail Link to this property
Link to this property
class BindingWorkersBindingKindService: … name: str A JavaScript variable name for the binding. Link to this property service: str Name of Worker to bind to. Link to this property type: Literal\["service"] The kind of resource that the binding provides. Link to this property entrypoint: Optional\[str] Entrypoint to invoke on the target Worker. Link to this property environment: Optional\[str] Optional environment if the Worker utilizes one. Link to this property
Link to this property
class BindingWorkersBindingKindTextBlob: … name: str A JavaScript variable name for the binding. Link to this property part: str The name of the file containing the text content. Only accepted for service worker syntax Workers. Link to this property Deprecatedtype: Literal\["text\_blob"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindVectorize: … index\_name: str Name of the Vectorize index to bind to. Link to this property name: str A JavaScript variable name for the binding. Link to this property type: Literal\["vectorize"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindVersionMetadata: … name: str A JavaScript variable name for the binding. Link to this property type: Literal\["version\_metadata"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindSecretsStoreSecret: … name: str A JavaScript variable name for the binding. Link to this property secret\_name: str Name of the secret in the store. Link to this property store\_id: str ID of the store containing the secret. Link to this property type: Literal\["secrets\_store\_secret"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindFlagship: … app\_id: str ID of the Flagship app to bind to for feature flag evaluation. maxLength128 Link to this property name: str A JavaScript variable name for the binding. Link to this property type: Literal\["flagship"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindSecretKey: … algorithm: object Algorithm-specific key parameters. Learn more. Link to this property
format: Literal\["raw", "pkcs8", "spki", "jwk"] Data format of the key. Learn more. One of the following: "raw" Link to this property "pkcs8" Link to this property "spki" Link to this property "jwk" Link to this property
Link to this property name: str A JavaScript variable name for the binding. Link to this property type: Literal\["secret\_key"] The kind of resource that the binding provides. Link to this property
usages: List\[Literal\["encrypt", "decrypt", "sign", 5 more]] Allowed operations with the key. Learn more. One of the following: "encrypt" Link to this property "decrypt" Link to this property "sign" Link to this property "verify" Link to this property "deriveKey" Link to this property "deriveBits" Link to this property "wrapKey" Link to this property "unwrapKey" Link to this property
Link to this property key\_base64: Optional\[str] Base64-encoded key data. Required if format is “raw”, “pkcs8”, or “spki”. Link to this property key\_jwk: Optional\[object] Key data in JSON Web Key format. Required if format is “jwk”. Link to this property
Link to this property
class BindingWorkersBindingKindWorkflow: … name: str A JavaScript variable name for the binding. Link to this property type: Literal\["workflow"] The kind of resource that the binding provides. Link to this property workflow\_name: str Name of the Workflow to bind to. Link to this property class\_name: Optional\[str] Class name of the Workflow. Should only be provided if the Workflow belongs to this script. Link to this property script\_name: Optional\[str] Script name that contains the Workflow. If not provided, defaults to this script name. Link to this property
Link to this property
class BindingWorkersBindingKindWasmModule: … name: str A JavaScript variable name for the binding. Link to this property part: str The name of the file containing the WebAssembly module content. Only accepted for service worker syntax Workers. Link to this property Deprecatedtype: Literal\["wasm\_module"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindVPCService: … name: str A JavaScript variable name for the binding. Link to this property service\_id: str Identifier of the VPC service to bind to. Link to this property type: Literal\["vpc\_service"] The kind of resource that the binding provides. Link to this property
Link to this property
class BindingWorkersBindingKindVPCNetwork: … name: str A JavaScript variable name for the binding. Link to this property type: Literal\["vpc\_network"] The kind of resource that the binding provides. Link to this property identity: Optional\[Literal\["runtime-email-alpha"]] Enables Gateway identity for the binding. Requires network\_id to be “cf1:network” and cannot be combined with tunnel\_id. Link to this property network\_id: Optional\[str] Identifier of the network to bind to. Only “cf1:network” is currently supported. Mutually exclusive with tunnel\_id. Link to this property tunnel\_id: Optional\[str] UUID of the Cloudflare Tunnel to bind to. Mutually exclusive with network\_id. Link to this property
Link to this property
Link to this property
cache\_options: Optional\[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. Link to this property 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. Link to this property
Link to this property 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. Link to this property 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. Link to this property
exports: Optional\[Dict\[str, Exports]] Declarative exports for the Worker. Worker entrypoint entries (type: worker) carry cache configuration for that entrypoint. 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. Link to this property
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. Link to this property
Link to this property state: Optional\[Literal\["created"]] Live export. May be omitted; defaults to created. Link to this property
Link to this property
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" Link to this property "legacy-kv" Link to this property
Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property 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 Link to this property state: Optional\[Literal\["created"]] Live export. May be omitted; defaults to created. Link to this property
Link to this property
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. Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property
Link to this property
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 Link to this property state: Literal\["renamed"] Tombstone that renames the namespace’s class. Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property
Link to this property
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. Link to this property 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 Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property
Link to this property
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. Link to this property
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" Link to this property "legacy-kv" Link to this property
Link to this property 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 Link to this property type: Literal\["durable-object"] Marks this entry as a Durable Object export. Link to this property 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 Link to this property
Link to this property
Link to this property
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. Link to this property deleted: List\[str] Class names whose namespace was deleted by a deleted tombstone. Link to this property
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. Link to this property message: str Human-readable explanation. Link to this property
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" Link to this property "provisioned\_class\_missing\_from\_config" Link to this property "config\_export\_not\_in\_code" Link to this property "config\_references\_nonexistent\_class" Link to this property "orphaned\_provisioned\_namespace" Link to this property "storage\_type\_mismatch" Link to this property "free\_tier\_requires\_sqlite" Link to this property "invalid\_export" Link to this property "tombstone\_delete\_class\_still\_in\_code" Link to this property "tombstone\_delete\_blocked\_by\_external\_bindings" Link to this property "tombstone\_renamed\_to\_occupied" Link to this property "transferred\_pending\_not\_found" Link to this property "transferred\_target\_missing" Link to this property "transferred\_target\_mismatch" Link to this property "phase\_one\_transfer\_source\_missing" Link to this property "phase\_one\_transfer\_source\_namespace\_missing" Link to this property "phase\_one\_transfer\_target\_class\_provisioned" Link to this property "phase\_one\_transfer\_after\_commit\_mismatch" Link to this property "phase\_one\_transfer\_duplicate" Link to this property "phase\_one\_transfer\_target\_in\_dispatch\_namespace" Link to this property "phase\_one\_transfer\_source\_in\_dispatch\_namespace" Link to this property "transferred\_source\_in\_dispatch\_namespace" Link to this property "transferred\_target\_in\_dispatch\_namespace" Link to this property "container\_undeclared\_reference" Link to this property "container\_class\_not\_durable\_object" Link to this property "container\_wiring\_inconsistent" Link to this property "container\_multiple\_durable\_objects" Link to this property "transfer\_container\_parity\_mismatch" Link to this property "transfer\_container\_parity\_mismatch\_on\_commit" Link to this property "tombstone\_class\_still\_in\_code" Link to this property "stale\_tombstone" Link to this property "transfer\_receive\_already\_applied" Link to this property "transfer\_receive\_cleanup\_complete" Link to this property
Link to this property namespace\_id: Optional\[str] The provisioned namespace the entry relates to, when applicable. formatuuid Link to this property 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. Link to this property
Link to this property removable\_entries: List\[str] Source class names whose tombstone entry is now stale and safe to delete from exports (no remaining referencing scripts). Link to this property
renamed: List\[ExportsReconciliationRenamed] Applied renamed tombstones. from\_: str The original (source) class name. Link to this property to: str The new class name (renamed_to). Link to this property
Link to this property
transfer\_pending: List\[ExportsReconciliationTransferPending] Phase-1 transfer hints recorded on the target side. class\_: str The target-side class name awaiting transfer. Link to this property from\_: str The source script the namespace will be transferred from. Link to this property
Link to this property
transferred: List\[ExportsReconciliationTransferred] Committed transferred tombstones (phase-2). class\_: str The source class name that was transferred. Link to this property phase: Literal\["committed"] The transfer phase. Currently always committed. Link to this property to: str The destination script that now owns the namespace. Link to this property
Link to this property updated: List\[str] Class names whose provisioned namespace was mutated in place. Link to this property
warnings: List\[ExportsReconciliationWarning] Non-blocking warnings. See exports_reconciliation_warning. class\_: str The class name the warning is about. Link to this property message: str Human-readable explanation of the warning. Link to this property
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" Link to this property "provisioned\_class\_missing\_from\_config" Link to this property "config\_export\_not\_in\_code" Link to this property "config\_references\_nonexistent\_class" Link to this property "orphaned\_provisioned\_namespace" Link to this property "storage\_type\_mismatch" Link to this property "free\_tier\_requires\_sqlite" Link to this property "invalid\_export" Link to this property "tombstone\_delete\_class\_still\_in\_code" Link to this property "tombstone\_delete\_blocked\_by\_external\_bindings" Link to this property "tombstone\_renamed\_to\_occupied" Link to this property "transferred\_pending\_not\_found" Link to this property "transferred\_target\_missing" Link to this property "transferred\_target\_mismatch" Link to this property "phase\_one\_transfer\_source\_missing" Link to this property "phase\_one\_transfer\_source\_namespace\_missing" Link to this property "phase\_one\_transfer\_target\_class\_provisioned" Link to this property "phase\_one\_transfer\_after\_commit\_mismatch" Link to this property "phase\_one\_transfer\_duplicate" Link to this property "phase\_one\_transfer\_target\_in\_dispatch\_namespace" Link to this property "phase\_one\_transfer\_source\_in\_dispatch\_namespace" Link to this property "transferred\_source\_in\_dispatch\_namespace" Link to this property "transferred\_target\_in\_dispatch\_namespace" Link to this property "container\_undeclared\_reference" Link to this property "container\_class\_not\_durable\_object" Link to this property "container\_wiring\_inconsistent" Link to this property "container\_multiple\_durable\_objects" Link to this property "transfer\_container\_parity\_mismatch" Link to this property "transfer\_container\_parity\_mismatch\_on\_commit" Link to this property "tombstone\_class\_still\_in\_code" Link to this property "stale\_tombstone" Link to this property "transfer\_receive\_already\_applied" Link to this property "transfer\_receive\_cleanup\_complete" Link to this property
Link to this property namespace\_id: Optional\[str] The provisioned namespace the warning relates to, when applicable. formatuuid Link to this property
Link to this property
Link to this property
limits: Optional\[Limits] Limits to apply for this Worker. cpu\_ms: Optional\[int] The amount of CPU time this Worker can use in milliseconds. Link to this property subrequests: Optional\[int] The number of subrequests this Worker can make per request. Link to this property
Link to this property logpush: Optional\[bool] Whether Logpush is turned on for the Worker. Link to this property
migrations: Optional\[Migrations] Migrations to apply for Durable Objects associated with this Worker. 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. Link to this property new\_classes: Optional\[List\[str]] A list of classes to create Durable Object namespaces from. Link to this property new\_sqlite\_classes: Optional\[List\[str]] A list of classes to create Durable Object namespaces with SQLite from. Link to this property new\_tag: Optional\[str] Tag to set as the latest migration tag. Link to this property 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. Link to this property
renamed\_classes: Optional\[List\[RenamedClass]] A list of classes with Durable Object namespaces that were renamed. from\_: Optional\[str] Link to this property to: Optional\[str] Link to this property
Link to this property
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] Link to this property from\_script: Optional\[str] Link to this property to: Optional\[str] Link to this property
Link to this property
Link to this property
class MigrationsWorkersMultipleStepMigrations: … new\_tag: Optional\[str] Tag to set as the latest migration tag. Link to this property 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. Link to this property
steps: Optional\[List\[MigrationStep]] Migrations to apply in order. deleted\_classes: Optional\[List\[str]] A list of classes to delete Durable Object namespaces from. Link to this property new\_classes: Optional\[List\[str]] A list of classes to create Durable Object namespaces from. Link to this property new\_sqlite\_classes: Optional\[List\[str]] A list of classes to create Durable Object namespaces with SQLite from. Link to this property
renamed\_classes: Optional\[List\[RenamedClass]] A list of classes with Durable Object namespaces that were renamed. from\_: Optional\[str] Link to this property to: Optional\[str] Link to this property
Link to this property
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] Link to this property from\_script: Optional\[str] Link to this property to: Optional\[str] Link to this property
Link to this property
Link to this property
Link to this property
Link to this property
observability: Optional\[Observability] Observability settings for the Worker. enabled: bool Whether observability is enabled for the Worker. Link to this property head\_sampling\_rate: Optional\[float] The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1. Link to this property
issues: Optional\[ObservabilityIssues] Real-time Issues settings for the Worker. enabled: Optional\[bool] Whether real-time Issues are enabled for the Worker. Link to this property
Link to this property
logs: Optional\[ObservabilityLogs] Log settings for the Worker. enabled: bool Whether logs are enabled for the Worker. Link to this property invocation\_logs: bool Whether invocation logs are enabled for the Worker. Link to this property destinations: Optional\[List\[str]] A list of destinations where logs will be exported to. Link to this property head\_sampling\_rate: Optional\[float] The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1. Link to this property persist: Optional\[bool] Whether log persistence is enabled for the Worker. Link to this property
Link to this property redact\_query\_string: Optional\[bool] Whether query strings are removed from request URLs in logs and traces. Link to this property
traces: Optional\[ObservabilityTraces] Trace settings for the Worker. destinations: Optional\[List\[str]] A list of destinations where traces will be exported to. Link to this property enabled: Optional\[bool] Whether traces are enabled for the Worker. Link to this property head\_sampling\_rate: Optional\[float] The sampling rate for traces. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1. Link to this property persist: Optional\[bool] Whether trace persistence is enabled for the Worker. Link to this property
propagation\_policy: Optional\[Literal\["authenticated", "accept"]] Controls how inbound trace context (traceparent/tracestate) headers on incoming requests are handled. “authenticated” honors inbound trace context only when accompanied by a valid trace auth token. “accept” unconditionally accepts inbound trace context. Requires the trace propagation feature to be enabled. Returns null when the trace propagation feature is not enabled for the account. One of the following: "authenticated" Link to this property "accept" Link to this property
Link to this property
Link to this property
Link to this property
placement: Optional\[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. Link to this property
Link to this property
class PlacementRegion: … region: str Cloud region for targeted placement in format ‘provider:region’. Link to this property
Link to this property
class PlacementHostname: … hostname: str HTTP hostname for targeted placement. Link to this property
Link to this property
class PlacementHost: … host: str TCP host and port for targeted placement. Link to this property
Link to this property
class PlacementUnionMember4: … mode: Literal\["targeted"] Targeted placement mode. Link to this property region: str Cloud region for targeted placement in format ‘provider:region’. Link to this property
Link to this property
class PlacementUnionMember5: … hostname: str HTTP hostname for targeted placement. Link to this property mode: Literal\["targeted"] Targeted placement mode. Link to this property
Link to this property
class PlacementUnionMember6: … host: str TCP host and port for targeted placement. Link to this property mode: Literal\["targeted"] Targeted placement mode. Link to this property
Link to this property
class PlacementUnionMember7: … mode: Literal\["targeted"] Targeted placement mode. Link to this property
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’. Link to this property
Link to this property
class PlacementUnionMember7TargetHostname: … hostname: str HTTP hostname for targeted placement. Link to this property
Link to this property
class PlacementUnionMember7TargetHost: … host: str TCP host:port for targeted placement. Link to this property
Link to this property
Link to this property
Link to this property
Link to this property tags: Optional\[List\[str]] Tags associated with the Worker. Link to this property
tail\_consumers: Optional\[List\[ConsumerScript]] List of Workers that will consume logs from the attached Worker. service: str Name of Worker that is to be the consumer. Link to this property environment: Optional\[str] Optional environment if the Worker utilizes one. Link to this property namespace: Optional\[str] Optional dispatch namespace the script belongs to. Link to this property
Link to this property
usage\_model: Optional\[Literal\["standard", "bundled", "unbound"]] Usage model for the Worker invocations. One of the following: "standard" Link to this property "bundled" Link to this property "unbound" Link to this property
Link to this property
[Link to this property](<#(resource)%20workers.scripts.script_and_version_settings%20%3E%20(model)%20script_and_version_setting_edit_response%20%3E%20(schema)>)