APIs.io Engineering Platform Workers for Platforms API
The Workers for Platforms API from APIs.io Engineering Platform — 10 operation(s) for workers for platforms.
This API exposes 19 operations across 10 paths, and defines 54 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.
19 operations
10 paths
54 schemas
3 DELETE9 GET1 PATCH1 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
APIs.io Engineering Platform Workers for Platforms 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 19
Across 10 paths, the API surfaces 19 operations — 3 DELETE, 9 GET, 1 PATCH, 1 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
Workers for Platforms 19
GET
/accounts/{account_id}/workers/dispatch/namespaces
APIs.io Engineering Platform List dispatch namespaces
POST
/accounts/{account_id}/workers/dispatch/namespaces
APIs.io Engineering Platform Create dispatch namespace
DELETE
/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}
APIs.io Engineering Platform Delete dispatch namespace
GET
/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}
APIs.io Engineering Platform Get dispatch namespace
DELETE
/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}
APIs.io Engineering Platform Delete Worker
GET
/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}
APIs.io Engineering Platform Worker Details
PUT
/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}
APIs.io Engineering Platform Upload Worker Module
GET
/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/bindings
APIs.io Engineering Platform Get Script Bindings
GET
/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/content
APIs.io Engineering Platform Get Script Content
PUT
/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/content
APIs.io Engineering Platform Put Script Content
GET
/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/secrets
APIs.io Engineering Platform List Script Secrets
PUT
/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/secrets
APIs.io Engineering Platform Put Script Secrets
GET
/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/secrets/{secret_name}
APIs.io Engineering Platform Get Script Secret
GET
/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/settings
APIs.io Engineering Platform Get Script Settings
PATCH
/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/settings
APIs.io Engineering Platform Patch Script Settings
GET
/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/tags
APIs.io Engineering Platform Get Script Tags
PUT
/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/tags
APIs.io Engineering Platform Put Script Tags
DELETE
/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/tags/{tag}
APIs.io Engineering Platform Delete Script Tag
PUT
/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/tags/{tag}
APIs.io Engineering Platform Put Script Tag
Schemas 54
The contract defines 54 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_namespace-response (7 properties), workers_do_binding (6 properties). Each schema is shown below with its type and property counts.
workers_binding_name
string
A JavaScript variable name for the binding.
workers_namespace-script-response
object
Details about a worker uploaded to a Workers for Platforms namespace.
4 properties
workers_api-response-single
object
workers_script-response-upload-single
workers_script_count
integer
The current number of scripts in this Dispatch Namespace
workers_namespace-list-response
workers_secret
object
3 properties
workers_dispatch_namespace_binding
object
4 properties
3 required
workers_modified_on
string
When the script was last modified.
workers_placement_config
object
1 property
workers_namespace-single-response
workers_created_on
string
When the script was created.
workers_namespace-response
object
7 properties
workers_compatibility_flags
array
Opt your Worker into specific changes
workers_binding
object
A binding to allow the Worker to communicate with resources
workers_tag
string
Tag to help you manage your Worker
workers_bindings
array
List of bindings attached to this Worker
workers_namespace-delete-response
workers_namespace_identifier
string
Namespace identifier tag.
workers_secret_name
string
A JavaScript variable name for the secret binding.
workers_api-response-common
object
3 properties
3 required
workers_script-response-single
workers_script-and-version-settings-item
object
10 properties
workers_api-response-common-failure
object
4 properties
4 required
workers_compatibility_date
string
Opt your Worker into changes after this date
workers_migration_tag_conditions
object
2 properties
workers_migration_step
object
5 properties
workers_dispatch_namespace_name
string
Name of the Workers for Platforms dispatch namespace.
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 properties
3 required
workers_tail_consumers
array
List of Workers that will consume logs from the attached Worker.
workers_secret-response
object
2 properties
workers_stepped_migrations
workers_r2_binding
object
3 properties
3 required
workers_messages
array
workers_placement_mode
string
Specifies the placement mode for the Worker (e.g. 'smart').
workers_do_binding
object
6 properties
3 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_single_step_migrations
A single set of migrations to apply.
workers_service_binding
object
4 properties
4 required
workers_identifier
string
Identifier
workers_uuid
string
API Resource UUID tag.
workers_tags
array
Tags to help you manage your Workers
workers_mtls_cert_binding
object
3 properties
3 required
workers_tail_consumers_script
object
A reference to a script that will consume logs from the attached Worker.
3 properties
1 required
workers_d1_binding
object
4 properties
4 required
workers_kv_namespace_binding
object
3 properties
3 required
workers_logpush
boolean
Whether Logpush is turned on for the Worker.
workers_namespace-script-response-single
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Workers for Platforms