This API exposes
12 operations
across 7 paths,
and defines 49 schemas.
It is described by OpenAPI 3.0.0, at version 2015-07-09.
Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.
12 operations7 paths49 schemas1 DELETE6 GET2 PATCH3 PUT
Metadata
The identity and technical contract details declared by the specification.
APIs.io Engineering Platform Worker Script API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac — Amazon Signature authorization v4
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.
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_binding_name
string
A JavaScript variable name for the binding.
workers_api-response-single
object
workers_script-response-upload-single
workers_script-settings-response
workers_dispatch_namespace_binding
object
4 properties3 required
workers_modified_on
string
When the script was last modified.
workers_placement_config
object
1 property
workers_created_on
string
When the script was created.
workers_compatibility_flags
array
Opt your Worker into specific changes
workers_script-response-collection
workers_binding
object
A binding to allow the Worker to communicate with resources
workers_tag
string
Tag to help you manage your Worker
workers_namespace_identifier
string
Namespace identifier tag.
workers_api-response-common
object
3 properties3 required
workers_script-response-single
workers_script-and-version-settings-item
object
10 properties
workers_api-response-common-failure
object
4 properties4 required
workers_compatibility_date
string
Opt your Worker into changes after this date
workers_migration_tag_conditions
object
2 properties
workers_usage-model-response
workers_migration_step
object
5 properties
workers_usage_model
string
Specifies the usage model for the Worker (e.g. 'bundled' or 'unbound').
workers_etag
string
Hashed script content, can be used in a If-None-Match header when updating.
workers_queue_binding
object
3 properties3 required
workers_tail_consumers
array
List of Workers that will consume logs from the attached Worker.
workers_stepped_migrations
workers_r2_binding
object
3 properties3 required
workers_messages
array
workers_placement_mode
string
Specifies the placement mode for the Worker (e.g. 'smart').
workers_script-and-version-settings-response
workers_do_binding
object
6 properties3 required
workers_limits
object
Limits to apply for this Worker.
1 property
workers_script-response-upload
workers_script-response
object
8 properties
workers_script_name
string
Name of the script, used in URLs and route configuration.
workers_compatibility_flag
string
A flag to opt into a specific change
workers_kv_namespace_binding
object
3 properties3 required
workers_single_step_migrations
A single set of migrations to apply.
workers_service_binding
object
4 properties4 required
workers_identifier
string
Identifier
workers_script-settings-item
object
2 properties
workers_uuid
string
API Resource UUID tag.
workers_tags
array
Tags to help you manage your Workers
workers_mtls_cert_binding
object
3 properties3 required
workers_tail_consumers_script
object
A reference to a script that will consume logs from the attached Worker.
3 properties1 required
workers_d1_binding
object
4 properties4 required
workers_bindings
array
List of bindings attached to this Worker
workers_usage-model-object
object
1 property
workers_logpush
boolean
Whether Logpush is turned on for the Worker.
Specification
The full machine-readable OpenAPI contract behind this narrative.
