Cloudflare API | Workers › Scripts

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.

Edit Worker -> Envelope<

Worker

patch/accounts/{account_id}/workers/workers/{worker_id}

Perform a partial update on a Worker, where omitted properties are left unchanged from their current values.

Delete Worker -> { errors, messages, success }

delete/accounts/{account_id}/workers/workers/{worker_id}

Delete a Worker and all its associated resources (versions, deployments, etc.).

Domain types

Worker = { id, created_on, logpush, 7 more... }

Workers Beta Workers

Versions

workers.beta.workers.versions

Methods

List Versions -> V4PagePaginationArray<

Version

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

List all versions for a Worker.

Get Version -> Envelope<

Version

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

Get details about a specific version.

Create Version -> Envelope<

Version

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

Create a new version.

Delete Version -> { errors, messages, success }

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

Delete a version.

Domain types

Version = { id, created_on, number, 12 more... }

Workers

Domains

workers.domains

Methods

List Domains -> SinglePage<

Domain

get/accounts/{account_id}/workers/domains

Lists all Worker Domains for an account.

Get A Domain -> Envelope<

Domain

get/accounts/{account_id}/workers/domains/{domain_id}

Gets a Worker domain.

Attach To Domain -> Envelope<

Domain

put/accounts/{account_id}/workers/domains

Attaches a Worker to a zone and hostname.

Detach From Domain ->

delete/accounts/{account_id}/workers/domains/{domain_id}

Detaches a Worker from a zone and hostname.

Domain types

Domain = { id, environment, hostname, 3 more... }

Workers

Observability

workers.observability

Workers Observability

Telemetry

workers.observability.telemetry

Methods

List Keys -> SinglePage<{ key, lastSeenAt, type }>

post/accounts/{account_id}/workers/observability/telemetry/keys

List all the keys in your telemetry events.

Run A Query -> Envelope<{ run, statistics, calculations, 4 more... }>

post/accounts/{account_id}/workers/observability/telemetry/query

Runs a temporary or saved query

List Values -> SinglePage<{ dataset, key, type, 1 more... }>

post/accounts/{account_id}/workers/observability/telemetry/values

List unique values found in your events

Workers

Routes

workers.routes

Methods

List Routes -> SinglePage<{ id, pattern, script }>

get/zones/{zone_id}/workers/routes

Returns routes for a zone.

Get Route -> Envelope<{ id, pattern, script }>

get/zones/{zone_id}/workers/routes/{route_id}

Returns information about a route, including URL pattern and Worker.

Create Route -> Envelope<{ id, pattern, script }>

post/zones/{zone_id}/workers/routes

Creates a route that maps a URL pattern to a Worker.

Update Route -> Envelope<{ id, pattern, script }>

put/zones/{zone_id}/workers/routes/{route_id}

Updates the URL pattern or Worker associated with a route.

Delete Route -> Envelope<{ id }>

delete/zones/{zone_id}/workers/routes/{route_id}

Deletes a route.

Workers

Scripts

workers.scripts

Methods

List Workers -> SinglePage<

Script

get/accounts/{account_id}/workers/scripts

Fetch a list of uploaded workers.

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Workers Tail Read Workers Scripts Write Workers Scripts Read

path Parameters

account_id: string

(maxLength: 32)

Identifier.

query Parameters

tags: string

Optional

Filter scripts by tags. Format: comma-separated list of tag:allowed pairs where allowed is 'yes' or 'no'.

Response fields

errors: Array<{ code, message, documentation_url, 1 more... }>

messages: Array<{ code, message, documentation_url, 1 more... }>

result: Array<

Script

success: true

Whether the API call was successful.

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/workers/scripts \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "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",
      "compatibility_date": "2021-01-01",
      "compatibility_flags": [
        "nodejs_compat"
      ],
      "created_on": "2017-01-01T00:00:00Z",
      "etag": "ea95132c15732412d22c1476fa83f27a",
      "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"
        }
      ],
      "placement": {
        "last_analyzed_at": "2025-01-01T00:00:00Z",
        "mode": "smart",
        "status": "SUCCESS"
      },
      "placement_mode": "smart",
      "placement_status": "SUCCESS",
      "tail_consumers": [
        {
          "service": "my-log-consumer",
          "environment": "production",
          "namespace": "my-namespace"
        }
      ],
      "usage_model": "standard"
    }
  ],
  "success": true
}

Search Workers -> Envelope<Array<{ created_on, modified_on, script_name, 4 more... }>>

get/accounts/{account_id}/workers/scripts-search

Search for Workers in an account.

Download Worker -> string

get/accounts/{account_id}/workers/scripts/{script_name}

Fetch raw script content for your worker. Note this is the original script content, not JSON encoded.

Upload Worker Module -> Envelope<{ startup_time_ms, id, compatibility_date, 16 more... }>

put/accounts/{account_id}/workers/scripts/{script_name}

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 Worker -> Envelope<unknown>

delete/accounts/{account_id}/workers/scripts/{script_name}

Delete your worker. This call has no response body on a successful delete.

Domain types

Script = { id, compatibility_date, compatibility_flags, 15 more... }

ScriptSetting = { logpush, observability, tags, 1 more... }

Workers Scripts

Assets

workers.scripts.assets

Workers Scripts Assets

Upload

workers.scripts.assets.upload

Methods

Create Assets Upload Session -> Envelope<{ buckets, jwt }>

post/accounts/{account_id}/workers/scripts/{script_name}/assets-upload-session

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/.

Workers Scripts

Content

workers.scripts.content

Methods

Get Script Content -> unknown

get/accounts/{account_id}/workers/scripts/{script_name}/content/v2

Fetch script content only.

Put Script Content -> Envelope<

Script

put/accounts/{account_id}/workers/scripts/{script_name}/content

Put script content without touching config or metadata.

Workers Scripts

Deployments

workers.scripts.deployments

Methods

List Deployments -> Envelope<{ deployments }>

get/accounts/{account_id}/workers/scripts/{script_name}/deployments

List of Worker Deployments. The first deployment in the list is the latest deployment actively serving traffic.

Create Deployment -> Envelope<

Deployment

post/accounts/{account_id}/workers/scripts/{script_name}/deployments

Deployments configure how Worker Versions are deployed to traffic. A deployment can consist of one or two versions of a Worker.

Get Deployment -> Envelope<

Deployment

get/accounts/{account_id}/workers/scripts/{script_name}/deployments/{deployment_id}

Get information about a Worker Deployment.

Delete Deployment -> { errors, messages, success }

delete/accounts/{account_id}/workers/scripts/{script_name}/deployments/{deployment_id}

Delete a Worker Deployment. The latest deployment, which is actively serving traffic, cannot be deleted. All other deployments can be deleted.

Domain types

Deployment = { id, created_on, source, 4 more... }

Workers Scripts

Schedules

workers.scripts.schedules

Methods

Get Cron Triggers -> Envelope<{ schedules }>

get/accounts/{account_id}/workers/scripts/{script_name}/schedules

Fetches Cron Triggers for a Worker.

Update Cron Triggers -> Envelope<{ schedules }>

put/accounts/{account_id}/workers/scripts/{script_name}/schedules

Updates Cron Triggers for a Worker.

Workers Scripts

Script And Version Settings

workers.scripts.script_and_version_settings

Methods

Get Settings -> Envelope<{ bindings, compatibility_date, compatibility_flags, 8 more... }>

get/accounts/{account_id}/workers/scripts/{script_name}/settings

Get metadata and config, such as bindings or usage model.

Patch Settings -> Envelope<{ bindings, compatibility_date, compatibility_flags, 8 more... }>

patch/accounts/{account_id}/workers/scripts/{script_name}/settings

Patch metadata or config, such as bindings or usage model.

Workers Scripts

Secrets

workers.scripts.secrets

Methods

List Script Secrets -> SinglePage<{ name, text, type } | { algorithm, format, name, 4 more... }>

get/accounts/{account_id}/workers/scripts/{script_name}/secrets

List secrets bound to a script.

Get Secret Binding -> Envelope<{ name, text, type } | { algorithm, format, name, 4 more... }>

get/accounts/{account_id}/workers/scripts/{script_name}/secrets/{secret_name}

Get a given secret binding (value omitted) on a script.

Add Script Secret -> Envelope<{ name, text, type } | { algorithm, format, name, 4 more... }>

put/accounts/{account_id}/workers/scripts/{script_name}/secrets

Add a secret to a script.

Delete Script Secret -> Envelope<unknown>

delete/accounts/{account_id}/workers/scripts/{script_name}/secrets/{secret_name}

Remove a secret from a script.

Workers Scripts

Settings

workers.scripts.settings

Methods

Get Script Settings -> Envelope<

ScriptSetting

get/accounts/{account_id}/workers/scripts/{script_name}/script-settings

Get script-level settings when using Worker Versions. Includes Logpush and Tail Consumers.

Patch Script Settings -> Envelope<

ScriptSetting

patch/accounts/{account_id}/workers/scripts/{script_name}/script-settings

Patch script-level settings when using Worker Versions. Including but not limited to Logpush and Tail Consumers.

Workers Scripts

Subdomain

workers.scripts.subdomain

Methods

Get Worker Subdomain -> Envelope<{ enabled, previews_enabled }>

get/accounts/{account_id}/workers/scripts/{script_name}/subdomain

Get if the Worker is available on the workers.dev subdomain.

Post Worker Subdomain -> Envelope<{ enabled, previews_enabled }>

post/accounts/{account_id}/workers/scripts/{script_name}/subdomain

Enable or disable the Worker on the workers.dev subdomain.

Delete Worker Subdomain -> Envelope<{ enabled, previews_enabled }>

delete/accounts/{account_id}/workers/scripts/{script_name}/subdomain

Disable all workers.dev subdomains for a Worker.

Workers Scripts

Tail

workers.scripts.tail

Methods

List Tails -> Envelope<{ id, expires_at, url }>

get/accounts/{account_id}/workers/scripts/{script_name}/tails

Get list of tails currently deployed on a Worker.

Start Tail -> Envelope<{ id, expires_at, url }>

post/accounts/{account_id}/workers/scripts/{script_name}/tails

Starts a tail that receives logs and exception from a Worker.

Delete Tail -> { errors, messages, success }

delete/accounts/{account_id}/workers/scripts/{script_name}/tails/{id}

Deletes a tail from a Worker.

Domain types

ConsumerScript = { service, environment, namespace }

A reference to a script that will consume logs from the attached Worker.

Workers Scripts

Versions

workers.scripts.versions

Methods

List Versions -> V4PagePagination<{ id, metadata, number }>

get/accounts/{account_id}/workers/scripts/{script_name}/versions

List of Worker Versions. The first version in the list is the latest version.

Get Version Detail -> Envelope<{ resources, id, metadata, 1 more... }>

get/accounts/{account_id}/workers/scripts/{script_name}/versions/{version_id}

Get Version Detail

Upload Version -> Envelope<{ resources, id, metadata, 2 more... }>

post/accounts/{account_id}/workers/scripts/{script_name}/versions

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/.

Workers

Subdomains

workers.subdomains

Methods

Get Subdomain -> Envelope<{ subdomain }>

get/accounts/{account_id}/workers/subdomain

Returns a Workers subdomain for an account.

Create Subdomain -> Envelope<{ subdomain }>

put/accounts/{account_id}/workers/subdomain

Creates a Workers subdomain for an account.