Beta

BetaWorkers

List Workers

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

GET/accounts/{account_id}/workers/workers

Get Worker

workers.beta.workers.get(, ) -> Worker

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

Create Worker

workers.beta.workers.create() -> Worker

POST/accounts/{account_id}/workers/workers

Update Worker

workers.beta.workers.update(, ) -> Worker

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

Edit Worker

workers.beta.workers.edit(, ) -> Worker

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

Delete Worker

workers.beta.workers.delete(, ) -> WorkerDeleteResponse

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

ModelsExpand Collapse

class Worker: …

id: str

Immutable ID of the Worker.

created_on: datetime

When the Worker was created.

formatdate-time

logpush: bool

Whether logpush is enabled for the Worker.

Name of the Worker.

observability: Observability

Observability settings for the Worker.

enabled: Optional[bool]

Whether observability is enabled for the Worker.

head_sampling_rate: Optional[float]

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

logs: Optional[ObservabilityLogs]

Log settings for the Worker.

destinations: Optional[List[str]]

A list of destinations where logs will be exported to.

enabled: Optional[bool]

Whether logs are enabled for the Worker.

head_sampling_rate: Optional[float]

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

invocation_logs: Optional[bool]

Whether invocation logs are enabled for the Worker.

persist: Optional[bool]

Whether log persistence is enabled for the Worker.

traces: Optional[ObservabilityTraces]

Trace settings for the Worker.

destinations: Optional[List[str]]

A list of destinations where traces will be exported to.

enabled: Optional[bool]

Whether traces are enabled for the Worker.

head_sampling_rate: Optional[float]

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

persist: Optional[bool]

Whether trace persistence is enabled for the Worker.

references: References

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

dispatch_namespace_outbounds: List[ReferencesDispatchNamespaceOutbound]

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

namespace_id: str

ID of the dispatch namespace.

namespace_name: str

Name of the dispatch namespace.

worker_id: str

ID of the Worker using the dispatch namespace.

worker_name: str

Name of the Worker using the dispatch namespace.

domains: List[ReferencesDomain]

Custom domains connected to the Worker.

id: str

ID of the custom domain.

certificate_id: str

ID of the TLS certificate issued for the custom domain.

hostname: str

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

zone_id: str

ID of the zone.

zone_name: str

Name of the zone.

durable_objects: List[ReferencesDurableObject]

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

namespace_id: str

ID of the Durable Object namespace being used.

namespace_name: str

Name of the Durable Object namespace being used.

worker_id: str

ID of the Worker using the Durable Object implementation.

worker_name: str

Name of the Worker using the Durable Object implementation.

queues: List[ReferencesQueue]

Queues that send messages to the Worker.

queue_consumer_id: str

ID of the queue consumer configuration.

queue_id: str

ID of the queue.

queue_name: str

Name of the queue.

workers: List[ReferencesWorker]

Other Workers that reference the Worker using service bindings.

id: str

ID of the referencing Worker.

Name of the referencing Worker.

subdomain: Subdomain

Subdomain settings for the Worker.

enabled: Optional[bool]

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

previews_enabled: Optional[bool]

Whether preview URLs are enabled for the Worker.

tags: List[str]

Tags associated with the Worker.

tail_consumers: List[TailConsumer]

Other Workers that should consume logs from the Worker.

Name of the consumer Worker.

updated_on: datetime

When the Worker was most recently updated.

formatdate-time

deployed_on: Optional[datetime]

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

formatdate-time

class WorkerDeleteResponse: …

errors: List[Error]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[ErrorSource]

pointer: Optional[str]

messages: List[Message]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[MessageSource]

pointer: Optional[str]

success: Literal[true]

Whether the API call was successful.

BetaWorkersVersions

List Versions

workers.beta.workers.versions.list(, ) -> SyncV4PagePaginationArray[Version]

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

Get Version

workers.beta.workers.versions.get(, ) -> Version

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

Create Version

workers.beta.workers.versions.create(, ) -> Version

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

Delete Version

workers.beta.workers.versions.delete(, ) -> VersionDeleteResponse

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

ModelsExpand Collapse

class Version: …

id: str

Version identifier.

formatuuid

created_on: datetime

When the version was created.

formatdate-time

number: int

The integer version number, starting from one.

urls: List[str]

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

annotations: Optional[Annotations]

Metadata about the version.

workers_message: Optional[str]

Human-readable message about the version.

maxLength100

workers_tag: Optional[str]

User-provided identifier for the version.

maxLength25

workers_triggered_by: Optional[str]

Operation that triggered the creation of the version.

assets: Optional[Assets]

Configuration for assets within a Worker.

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

config: Optional[AssetsConfig]

Configuration for assets within a Worker.

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

Determines the redirects and rewrites of requests for HTML content.

One of the following:

"auto-trailing-slash"

"force-trailing-slash"

"drop-trailing-slash"

"none"

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

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

One of the following:

"none"

"404-page"

"single-page-application"

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

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

One of the following:

List[str]

bool

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

jwt: Optional[str]

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

bindings: Optional[List[Binding]]

List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.

One of the following:

class BindingWorkersBindingKindAI: …

A JavaScript variable name for the binding.

type: Literal["ai"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindAISearch: …

instance_name: str

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

A JavaScript variable name for the binding.

type: Literal["ai_search"]

The kind of resource that the binding provides.

namespace: Optional[str]

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

class BindingWorkersBindingKindAISearchNamespace: …

A JavaScript variable name for the binding.

namespace: str

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

type: Literal["ai_search_namespace"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindAnalyticsEngine: …

dataset: str

The name of the dataset to bind to.

A JavaScript variable name for the binding.

type: Literal["analytics_engine"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindAssets: …

A JavaScript variable name for the binding.

type: Literal["assets"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindBrowser: …

A JavaScript variable name for the binding.

type: Literal["browser"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindD1: …

id: str

Identifier of the D1 database to bind to.

A JavaScript variable name for the binding.

type: Literal["d1"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindDataBlob: …

A JavaScript variable name for the binding.

part: str

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

Deprecatedtype: Literal["data_blob"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindDispatchNamespace: …

A JavaScript variable name for the binding.

namespace: str

The name of the dispatch namespace.

type: Literal["dispatch_namespace"]

The kind of resource that the binding provides.

outbound: Optional[BindingWorkersBindingKindDispatchNamespaceOutbound]

Outbound worker.

params: Optional[List[BindingWorkersBindingKindDispatchNamespaceOutboundParam]]

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

Name of the parameter.

worker: Optional[BindingWorkersBindingKindDispatchNamespaceOutboundWorker]

Outbound worker.

entrypoint: Optional[str]

Entrypoint to invoke on the outbound worker.

environment: Optional[str]

Environment of the outbound worker.

service: Optional[str]

Name of the outbound worker.

class BindingWorkersBindingKindDurableObjectNamespace: …

A JavaScript variable name for the binding.

type: Literal["durable_object_namespace"]

The kind of resource that the binding provides.

class_name: Optional[str]

The exported class name of the Durable Object.

dispatch_namespace: Optional[str]

The dispatch namespace the Durable Object script belongs to.

environment: Optional[str]

The environment of the script_name to bind to.

namespace_id: Optional[str]

Namespace identifier tag.

maxLength32

script_name: Optional[str]

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

class BindingWorkersBindingKindHyperdrive: …

id: str

Identifier of the Hyperdrive connection to bind to.

A JavaScript variable name for the binding.

type: Literal["hyperdrive"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindInherit: …

The name of the inherited binding.

type: Literal["inherit"]

The kind of resource that the binding provides.

old_name: Optional[str]

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

version_id: Optional[str]

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

class BindingWorkersBindingKindImages: …

A JavaScript variable name for the binding.

type: Literal["images"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindJson: …

json: object

JSON data to use.

A JavaScript variable name for the binding.

type: Literal["json"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindKVNamespace: …

A JavaScript variable name for the binding.

namespace_id: str

Namespace identifier tag.

maxLength32

type: Literal["kv_namespace"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindMedia: …

A JavaScript variable name for the binding.

type: Literal["media"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindMTLSCertificate: …

certificate_id: str

Identifier of the certificate to bind to.

A JavaScript variable name for the binding.

type: Literal["mtls_certificate"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindPlainText: …

A JavaScript variable name for the binding.

text: str

The text value to use.

type: Literal["plain_text"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindPipelines: …

A JavaScript variable name for the binding.

pipeline: str

Name of the Pipeline to bind to.

type: Literal["pipelines"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindQueue: …

A JavaScript variable name for the binding.

queue_name: str

Name of the Queue to bind to.

type: Literal["queue"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindRatelimit: …

A JavaScript variable name for the binding.

namespace_id: str

Identifier of the rate limit namespace to bind to.

simple: BindingWorkersBindingKindRatelimitSimple

The rate limit configuration.

limit: float

The limit (requests per period).

period: int

The period in seconds.

type: Literal["ratelimit"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindR2Bucket: …

bucket_name: str

R2 bucket to bind to.

A JavaScript variable name for the binding.

type: Literal["r2_bucket"]

The kind of resource that the binding provides.

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

The jurisdiction of the R2 bucket.

One of the following:

"eu"

"fedramp"

"fedramp-high"

class BindingWorkersBindingKindSecretText: …

A JavaScript variable name for the binding.

text: str

The secret value to use.

type: Literal["secret_text"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindSendEmail: …

A JavaScript variable name for the binding.

type: Literal["send_email"]

The kind of resource that the binding provides.

allowed_destination_addresses: Optional[List[str]]

List of allowed destination addresses.

allowed_sender_addresses: Optional[List[str]]

List of allowed sender addresses.

destination_address: Optional[str]

Destination address for the email.

formatemail

class BindingWorkersBindingKindService: …

A JavaScript variable name for the binding.

service: str

Name of Worker to bind to.

type: Literal["service"]

The kind of resource that the binding provides.

entrypoint: Optional[str]

Entrypoint to invoke on the target Worker.

environment: Optional[str]

Optional environment if the Worker utilizes one.

class BindingWorkersBindingKindTextBlob: …

A JavaScript variable name for the binding.

part: str

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

Deprecatedtype: Literal["text_blob"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindVectorize: …

index_name: str

Name of the Vectorize index to bind to.

A JavaScript variable name for the binding.

type: Literal["vectorize"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindVersionMetadata: …

A JavaScript variable name for the binding.

type: Literal["version_metadata"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindSecretsStoreSecret: …

A JavaScript variable name for the binding.

secret_name: str

Name of the secret in the store.

store_id: str

ID of the store containing the secret.

type: Literal["secrets_store_secret"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindSecretKey: …

algorithm: object

Algorithm-specific key parameters. Learn more.

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

Data format of the key. Learn more.

One of the following:

"raw"

"pkcs8"

"spki"

"jwk"

A JavaScript variable name for the binding.

type: Literal["secret_key"]

The kind of resource that the binding provides.

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

Allowed operations with the key. Learn more.

One of the following:

"encrypt"

"decrypt"

"sign"

"verify"

"deriveKey"

"deriveBits"

"wrapKey"

"unwrapKey"

key_base64: Optional[str]

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

key_jwk: Optional[object]

Key data in JSON Web Key format. Required if format is "jwk".

class BindingWorkersBindingKindWorkflow: …

A JavaScript variable name for the binding.

type: Literal["workflow"]

The kind of resource that the binding provides.

workflow_name: str

Name of the Workflow to bind to.

class_name: Optional[str]

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

script_name: Optional[str]

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

class BindingWorkersBindingKindWasmModule: …

A JavaScript variable name for the binding.

part: str

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

Deprecatedtype: Literal["wasm_module"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindVPCService: …

A JavaScript variable name for the binding.

service_id: str

Identifier of the VPC service to bind to.

type: Literal["vpc_service"]

The kind of resource that the binding provides.

class BindingWorkersBindingKindVPCNetwork: …

A JavaScript variable name for the binding.

type: Literal["vpc_network"]

The kind of resource that the binding provides.

network_id: Optional[str]

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

tunnel_id: Optional[str]

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

compatibility_date: Optional[str]

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

compatibility_flags: Optional[List[str]]

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

limits: Optional[Limits]

Resource limits enforced at runtime.

cpu_ms: int

CPU time limit in milliseconds.

main_module: Optional[str]

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

migrations: Optional[Migrations]

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

One of the following:

class SingleStepMigration: …

A single set of migrations to apply.

deleted_classes: Optional[List[str]]

A list of classes to delete Durable Object namespaces from.

new_classes: Optional[List[str]]

A list of classes to create Durable Object namespaces from.

new_sqlite_classes: Optional[List[str]]

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

new_tag: Optional[str]

Tag to set as the latest migration tag.

old_tag: Optional[str]

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

renamed_classes: Optional[List[RenamedClass]]

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

from_: Optional[str]

to: Optional[str]

transferred_classes: Optional[List[TransferredClass]]

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

from_: Optional[str]

from_script: Optional[str]

to: Optional[str]

class MigrationsWorkersMultipleStepMigrations: …

new_tag: Optional[str]

Tag to set as the latest migration tag.

old_tag: Optional[str]

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

steps: Optional[List[MigrationStep]]

Migrations to apply in order.

deleted_classes: Optional[List[str]]

A list of classes to delete Durable Object namespaces from.

new_classes: Optional[List[str]]

A list of classes to create Durable Object namespaces from.

new_sqlite_classes: Optional[List[str]]

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

renamed_classes: Optional[List[RenamedClass]]

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

from_: Optional[str]

to: Optional[str]

transferred_classes: Optional[List[TransferredClass]]

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

from_: Optional[str]

from_script: Optional[str]

to: Optional[str]

modules: Optional[List[Module]]

Code, sourcemaps, and other content used at runtime.

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

content_base64: str

The base64-encoded module content.

formatbyte

content_type: str

The content type of the module.

The name of the module.

placement: Optional[Placement]

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

One of the following:

class PlacementMode: …

mode: Literal["smart"]

Enables Smart Placement.

class PlacementRegion: …

region: str

Cloud region for targeted placement in format 'provider:region'.

class PlacementHostname: …

hostname: str

HTTP hostname for targeted placement.

class PlacementHost: …

host: str

TCP host and port for targeted placement.

class PlacementUnionMember4: …

mode: Literal["targeted"]

Targeted placement mode.

region: str

Cloud region for targeted placement in format 'provider:region'.

class PlacementUnionMember5: …

hostname: str

HTTP hostname for targeted placement.

mode: Literal["targeted"]

Targeted placement mode.

class PlacementUnionMember6: …

host: str

TCP host and port for targeted placement.

mode: Literal["targeted"]

Targeted placement mode.

class PlacementUnionMember7: …

mode: Literal["targeted"]

Targeted placement mode.

target: List[PlacementUnionMember7Target]

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

One of the following:

class PlacementUnionMember7TargetRegion: …

region: str

Cloud region in format 'provider:region'.

class PlacementUnionMember7TargetHostname: …

hostname: str

HTTP hostname for targeted placement.

class PlacementUnionMember7TargetHost: …

host: str

TCP host:port for targeted placement.

source: Optional[str]

The client used to create the version.

startup_time_ms: Optional[int]

Time in milliseconds spent on Worker startup.

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

Usage model for the version.

One of the following:

"standard"

"bundled"

"unbound"

class VersionDeleteResponse: …

errors: List[Error]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[ErrorSource]

pointer: Optional[str]

messages: List[Message]

code: int

minimum1000

message: str

documentation_url: Optional[str]

source: Optional[MessageSource]

pointer: Optional[str]

success: Literal[true]

Whether the API call was successful.