--- title: List Worker Scripts --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Workers](https://developers.cloudflare.com/api/python/resources/workers) [Scripts](https://developers.cloudflare.com/api/python/resources/workers/subresources/scripts) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List Worker Scripts workers.scripts.list(ScriptListParams\*\*kwargs) -> SyncSinglePage\[[ScriptListResponse]()] GET/accounts/{account\_id}/workers/scripts Fetch a list of uploaded Worker scripts. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Workers Tail Read``Workers Scripts Write``Workers Scripts Read` ##### ParametersExpand Collapse account\_id: str Identifier. maxLength32 [Link to this property](<#(resource)%20workers.scripts%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) tags: Optional\[str] Filter scripts by tags. Format: comma-separated list of tag:allowed pairs where allowed is ‘yes’ or ‘no’. [Link to this property](<#(resource)%20workers.scripts%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20tags%20%3E%20(schema)>) ##### ReturnsExpand Collapse
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 Worker Scripts Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) page = client.workers.scripts.list( account_id="023e105f4ecef8ad9ca31a8372d0c353", ) page = page.result[0] print(page.id) ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": [ { "id": "my-workers-script", "cache_options": { "enabled": true, "cross_version_cache": true }, "compatibility_date": "2021-01-01T00:00:00Z", "compatibility_flags": [ "nodejs_compat" ], "created_on": "2017-01-01T00:00:00Z", "etag": "ea95132c15732412d22c1476fa83f27a", "exports": { "Admin": { "type": "worker", "cache": { "enabled": true }, "state": "created" }, "Counter": { "storage": "sqlite", "type": "durable-object", "container": "my-container", "state": "created" }, "OldCounter": { "state": "renamed", "type": "durable-object" }, "default": { "type": "worker", "cache": { "enabled": false }, "state": "created" } }, "handlers": [ "fetch", "scheduled" ], "has_assets": false, "has_modules": false, "last_deployed_from": "wrangler", "logpush": false, "migration_tag": "v1", "modified_on": "2017-01-01T00:00:00Z", "named_handlers": [ { "handlers": [ "class" ], "name": "MyDurableObject" } ], "observability": { "enabled": true, "head_sampling_rate": 0.1, "issues": { "enabled": true }, "logs": { "enabled": true, "invocation_logs": true, "destinations": [ "cloudflare" ], "head_sampling_rate": 0.1, "persist": true }, "redact_query_string": false, "traces": { "destinations": [ "cloudflare" ], "enabled": true, "head_sampling_rate": 0.1, "persist": true, "propagation_policy": "authenticated" } }, "placement": { "mode": "smart", "last_analyzed_at": "2025-01-01T00:00:00Z", "status": "SUCCESS" }, "placement_mode": "smart", "placement_status": "SUCCESS", "routes": [ { "id": "023e105f4ecef8ad9ca31a8372d0c353", "pattern": "example.com/*", "script": "my-workers-script" } ], "tag": "e8f70fdbc8b1fb0b8ddb1af166186758", "tags": [ "my-team", "my-public-api" ], "tail_consumers": [ { "service": "my-log-consumer", "environment": "production", "namespace": "my-namespace" } ], "usage_model": "standard" } ], "success": true } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": [ { "id": "my-workers-script", "cache_options": { "enabled": true, "cross_version_cache": true }, "compatibility_date": "2021-01-01T00:00:00Z", "compatibility_flags": [ "nodejs_compat" ], "created_on": "2017-01-01T00:00:00Z", "etag": "ea95132c15732412d22c1476fa83f27a", "exports": { "Admin": { "type": "worker", "cache": { "enabled": true }, "state": "created" }, "Counter": { "storage": "sqlite", "type": "durable-object", "container": "my-container", "state": "created" }, "OldCounter": { "state": "renamed", "type": "durable-object" }, "default": { "type": "worker", "cache": { "enabled": false }, "state": "created" } }, "handlers": [ "fetch", "scheduled" ], "has_assets": false, "has_modules": false, "last_deployed_from": "wrangler", "logpush": false, "migration_tag": "v1", "modified_on": "2017-01-01T00:00:00Z", "named_handlers": [ { "handlers": [ "class" ], "name": "MyDurableObject" } ], "observability": { "enabled": true, "head_sampling_rate": 0.1, "issues": { "enabled": true }, "logs": { "enabled": true, "invocation_logs": true, "destinations": [ "cloudflare" ], "head_sampling_rate": 0.1, "persist": true }, "redact_query_string": false, "traces": { "destinations": [ "cloudflare" ], "enabled": true, "head_sampling_rate": 0.1, "persist": true, "propagation_policy": "authenticated" } }, "placement": { "mode": "smart", "last_analyzed_at": "2025-01-01T00:00:00Z", "status": "SUCCESS" }, "placement_mode": "smart", "placement_status": "SUCCESS", "routes": [ { "id": "023e105f4ecef8ad9ca31a8372d0c353", "pattern": "example.com/*", "script": "my-workers-script" } ], "tag": "e8f70fdbc8b1fb0b8ddb1af166186758", "tags": [ "my-team", "my-public-api" ], "tail_consumers": [ { "service": "my-log-consumer", "environment": "production", "namespace": "my-namespace" } ], "usage_model": "standard" } ], "success": true } ```