Workers
workers
Domain types
A single set of migrations to apply.
JSON-encoded metadata about the uploaded parts and Worker configuration.
Account Settings
workers.account_settings
Methods
Fetches Worker account settings for an account.
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
Trust and Safety Write Trust and Safety Read DNS View Write DNS View Read SCIM Provisioning Load Balancers Account Write Load Balancers Account Read Zero Trust: PII Read DDoS Botnet Feed Write DDoS Botnet Feed Read Workers R2 Storage Write Workers R2 Storage Read DDoS Protection Write DDoS Protection Read Workers Tail Read Workers KV Storage Write Workers KV Storage Read Workers Scripts Write Workers Scripts Read Load Balancing: Monitors and Pools Write Load Balancing: Monitors and Pools Read Account Firewall Access Rules Write Account Firewall Access Rules Read DNS Firewall Write DNS Firewall Read Billing Write Billing Read Account Settings Write Account Settings Read
Identifier.
Whether the API call was successful.
Creates Worker account settings for an account.
Assets
workers.assets
Methods
Upload assets ahead of creating a Worker version. To learn more about the direct uploads of assets, see https://developers.cloudflare.com/workers/static-assets/direct-upload/.
Beta
workers.beta
Methods
List all Workers for an account.
Get details about a specific Worker.
Create a new Worker.
Perform a complete replacement of a Worker, where omitted properties are set to their default values. This is the exact same as the Create Worker endpoint, but operates on an existing Worker. To perform a partial update instead, use the Edit Worker endpoint.
Perform a partial update on a Worker, where omitted properties are left unchanged from their current values.
Delete a Worker and all its associated resources (versions, deployments, etc.).
Domain types
Methods
List all versions for a Worker.
Get details about a specific version.
Create a new version.
Delete a version.
Domain types
Domains
workers.domains
Methods
Lists all Worker Domains for an account.
Gets a Worker domain.
Attaches a Worker to a zone and hostname.
Detaches a Worker from a zone and hostname.
Domain types
Observability
workers.observability
workers.observability.telemetry
Methods
List all the keys in your telemetry events.
Runs a temporary or saved query
List unique values found in your events
Routes
workers.routes
Methods
Returns routes for a zone.
Returns information about a route, including URL pattern and Worker.
Creates a route that maps a URL pattern to a Worker.
Updates the URL pattern or Worker associated with a route.
Deletes a route.
Scripts
workers.scripts
Methods
Fetch a list of uploaded workers.
Search for Workers in an account.
Fetch raw script content for your worker. Note this is the original script content, not JSON encoded.
Upload a worker module. You can find more about the multipart metadata on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/.
Delete your worker. This call has no response body on a successful delete.
Domain types
Methods
Start uploading a collection of assets for use in a Worker version. To learn more about the direct uploads of assets, see https://developers.cloudflare.com/workers/static-assets/direct-upload/.
Methods
Fetch script content only.
Put script content without touching config or metadata.
Methods
List of Worker Deployments. The first deployment in the list is the latest deployment actively serving traffic.
Deployments configure how Worker Versions are deployed to traffic. A deployment can consist of one or two versions of a Worker.
Get information about a Worker Deployment.
Delete a Worker Deployment. The latest deployment, which is actively serving traffic, cannot be deleted. All other deployments can be deleted.
Domain types
Methods
Fetches Cron Triggers for a Worker.
Updates Cron Triggers for a Worker.
Methods
Get metadata and config, such as bindings or usage model.
Patch metadata or config, such as bindings or usage model.
Methods
List secrets bound to a script.
Get a given secret binding (value omitted) on a script.
Add a secret to a script.
Remove a secret from a script.
Methods
Get script-level settings when using Worker Versions. Includes Logpush and Tail Consumers.
Patch script-level settings when using Worker Versions. Including but not limited to Logpush and Tail Consumers.
Methods
Get if the Worker is available on the workers.dev subdomain.
Enable or disable the Worker on the workers.dev subdomain.
Disable all workers.dev subdomains for a Worker.
Methods
Get list of tails currently deployed on a Worker.
Starts a tail that receives logs and exception from a Worker.
Deletes a tail from a Worker.
Domain types
A reference to a script that will consume logs from the attached Worker.
Methods
List of Worker Versions. The first version in the list is the latest version.
Get Version Detail
Upload a Worker Version without deploying to Cloudflare's network. You can find more about the multipart metadata on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/.
Subdomains
workers.subdomains
Methods
Returns a Workers subdomain for an account.
Creates a Workers subdomain for an account.
Deletes a Workers subdomain for an account.