How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Worker Script API

The Worker Script API from APIs.io Engineering Platform — 7 operation(s) for worker script.

APIs.io Engineering Platform Worker Script API is one of 471 APIs that APIs.io Engineering Platform publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Worker Script. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 12 operations across 7 paths, and defines 49 schemas. It is described by OpenAPI 3.2.0, at version 4.0.0.

Requests are made against the base URL https://{bucketname}.s3.amazonaws.com.

12 operations 7 paths 49 schemas 1 DELETE6 GET2 PATCH3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0.0
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key, API Key, HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 4

APIs.io Engineering Platform Worker Script API declares 4 security schemes for authenticating requests. An API key is passed in the header as X-Auth-Email (api_email). An API key is passed in the header as X-Auth-Key (api_key). It accepts HTTP bearer tokens (api_token). An API key is passed in the header as X-Auth-User-Service-Key (user_service_key).

Paths & Operations 12

Across 7 paths, the API surfaces 12 operations — 1 DELETE, 6 GET, 2 PATCH, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Worker Script 12
GET
/accounts/{account_id}/workers/scripts
APIs.io Engineering Platform List Workers
worker-script-list-workers 1 param → 4XX200
DELETE
/accounts/{account_id}/workers/scripts/{script_name}
APIs.io Engineering Platform Delete Worker
worker-script-delete-worker 3 params body → 4XX200
GET
/accounts/{account_id}/workers/scripts/{script_name}
APIs.io Engineering Platform Download Worker
worker-script-download-worker 2 params → 4XX200
PUT
/accounts/{account_id}/workers/scripts/{script_name}
APIs.io Engineering Platform Upload Worker Module
worker-script-upload-worker-module 3 params body → 4XX200
PUT
/accounts/{account_id}/workers/scripts/{script_name}/content
APIs.io Engineering Platform Put script content
worker-script-put-content 4 params body → 4XX200
GET
/accounts/{account_id}/workers/scripts/{script_name}/content/v2
APIs.io Engineering Platform Get script content
worker-script-get-content 2 params → 4XX200
GET
/accounts/{account_id}/workers/scripts/{script_name}/script-settings
APIs.io Engineering Platform Get Script Settings
worker-script-settings-get-settings 2 params → 4XX200
PATCH
/accounts/{account_id}/workers/scripts/{script_name}/script-settings
APIs.io Engineering Platform Patch Script Settings
worker-script-settings-patch-settings 2 params body → 4XX200
GET
/accounts/{account_id}/workers/scripts/{script_name}/settings
APIs.io Engineering Platform Get Settings
worker-script-get-settings 2 params → 4XX200
PATCH
/accounts/{account_id}/workers/scripts/{script_name}/settings
APIs.io Engineering Platform Patch Settings
worker-script-patch-settings 2 params body → 4XX200
GET
/accounts/{account_id}/workers/scripts/{script_name}/usage-model
APIs.io Engineering Platform Fetch Usage Model
worker-script-fetch-usage-model 2 params → 4XX200
PUT
/accounts/{account_id}/workers/scripts/{script_name}/usage-model
APIs.io Engineering Platform Update Usage Model
worker-script-update-usage-model 2 params body → 4XX200

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are workers_script-and-version-settings-item (10 properties), workers_script-response (8 properties), workers_do_binding (6 properties), workers_migration_step (5 properties). Each schema is shown below with its type and property counts.

workers_kv_namespace_binding
object
3 properties 3 required
workers_script-settings-response
workers_script-and-version-settings-response
workers_queue_binding
object
3 properties 3 required
workers_script-response-collection
workers_api-response-common
object
3 properties 3 required
workers_bindings
array
List of bindings attached to this Worker
workers_identifier
string
Identifier
workers_modified_on
string
When the script was last modified.
workers_usage-model-response
workers_namespace_identifier
string
Namespace identifier tag.
workers_messages
array
workers_tags
array
Tags to help you manage your Workers
workers_script-and-version-settings-item
object
10 properties
workers_usage_model
string
Specifies the usage model for the Worker (e.g. 'bundled' or 'unbound').
workers_tail_consumers_script
object
A reference to a script that will consume logs from the attached Worker.
3 properties 1 required
workers_api-response-common-failure
object
4 properties 4 required
workers_limits
object
Limits to apply for this Worker.
1 property
workers_api-response-single
object
workers_compatibility_flags
array
Opt your Worker into specific changes
workers_script-settings-item
object
2 properties
workers_d1_binding
object
4 properties 4 required
workers_script-response-upload-single
workers_migration_tag_conditions
object
2 properties
workers_tag
string
Tag to help you manage your Worker
workers_compatibility_date
string
Opt your Worker into changes after this date
workers_script-response-single
workers_usage-model-object
object
1 property
workers_logpush
boolean
Whether Logpush is turned on for the Worker.
workers_do_binding
object
6 properties 3 required
workers_stepped_migrations
workers_created_on
string
When the script was created.
workers_tail_consumers
array
List of Workers that will consume logs from the attached Worker.
workers_migration_step
object
5 properties
workers_binding_name
string
A JavaScript variable name for the binding.
workers_placement_mode
string
Specifies the placement mode for the Worker (e.g. 'smart').
workers_service_binding
object
4 properties 4 required
workers_single_step_migrations
A single set of migrations to apply.
workers_binding
object
A binding to allow the Worker to communicate with resources
workers_mtls_cert_binding
object
3 properties 3 required
workers_uuid
string
API Resource UUID tag.
workers_compatibility_flag
string
A flag to opt into a specific change
workers_dispatch_namespace_binding
object
4 properties 3 required
workers_r2_binding
object
3 properties 3 required
workers_script_name
string
Name of the script, used in URLs and route configuration.
workers_script-response
object
8 properties
workers_etag
string
Hashed script content, can be used in a If-None-Match header when updating.
workers_placement_config
object
1 property
workers_script-response-upload

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-worker-script-api-openapi.yml Raw ↑

Other APIs APIs.io Engineering Platform publishes across the network.

EasyCron
APIs.io Engineering Platform 2014 11 13 API
APIs.io Engineering Platform 2015 03 31 API
APIs.io Engineering Platform 2016 08 19 API
APIs.io Engineering Platform 2017 03 31 API
APIs.io Engineering Platform 2017 10 31 API
APIs.io Engineering Platform 2018 10 31 API
APIs.io Engineering Platform 2019 09 25 API
APIs.io Engineering Platform 2019 09 30 API
APIs.io Engineering Platform 2020 04 22 API
APIs.io Engineering Platform 2020 06 30 API
Where this information came from

This is an independent, third-party profile of APIs.io Engineering Platform Worker Script API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.