Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Worker Environment API

The Worker Environment API from APIs.io Engineering Platform — 2 operation(s) for worker environment.

This API exposes 4 operations across 2 paths, and defines 19 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.

4 operations 2 paths 19 schemas 2 GET1 PATCH1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Worker Environment 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 4

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

Worker Environment 4
GET
/accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/content
APIs.io Engineering Platform Get script content
worker-environment-get-script-content 3 params → 4XX200
PUT
/accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/content
APIs.io Engineering Platform Put script content
worker-environment-put-script-content 5 params body → 4XX200
GET
/accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/settings
APIs.io Engineering Platform Get Script Settings
worker-script-environment-get-settings 3 params → 4XX200
PATCH
/accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/settings
APIs.io Engineering Platform Patch Script Settings
worker-script-environment-patch-settings 3 params body → 4XX200

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are workers_script-response (8 properties), workers_api-response-common-failure (4 properties), workers_tail_consumers_script (3 properties), workers_api-response-common (3 properties). Each schema is shown below with its type and property counts.

workers_environment
string
Optional environment if the Worker utilizes one.
workers_api-response-single
object
workers_script-settings-response
workers_modified_on
string
When the script was last modified.
workers_created_on
string
When the script was created.
workers_api-response-common
object
3 properties 3 required
workers_script-response-single
workers_api-response-common-failure
object
4 properties 4 required
workers_service
string
Name of Worker to bind to
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_tail_consumers
array
List of Workers that will consume logs from the attached Worker.
workers_messages
array
workers_placement_mode
string
Specifies the placement mode for the Worker (e.g. 'smart').
workers_script-response
object
8 properties
workers_identifier
string
Identifier
workers_script-settings-item
object
2 properties
workers_tail_consumers_script
object
A reference to a script that will consume logs from the attached Worker.
3 properties 1 required
workers_logpush
boolean
Whether Logpush is turned on for the Worker.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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