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 Deployments API

The Worker Deployments API from APIs.io Engineering Platform — 1 operation(s) for worker deployments.

This API exposes 2 operations across 1 path, and defines 12 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.

2 operations 1 paths 12 schemas 1 GET1 POST

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 Deployments 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 2

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

Worker Deployments 2
GET
/accounts/{account_id}/workers/scripts/{script_name}/deployments
APIs.io Engineering Platform List Deployments
worker-deployments-list-deployments 2 params → 4XX200
POST
/accounts/{account_id}/workers/scripts/{script_name}/deployments
APIs.io Engineering Platform Create Deployment
worker-deployments-create-deployment 3 params body → 4XX200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are workers_deployments-base (6 properties), workers_api-response-common-failure (4 properties), workers_api-response-common (3 properties), workers_deployments-strategy-percentage (2 properties). Each schema is shown below with its type and property counts.

workers_deployments-strategy-percentage
object
2 properties 2 required
workers_identifier
string
Identifier
workers_schemas-deployment_identifier
string
workers_schemas-deployments-list-response
workers_deployments-base
object
6 properties
workers_schemas-deployments-single-response
workers_messages
array
workers_api-response-common
object
3 properties 3 required
workers_deployments-create-body
workers_schemas-script_name
string
Name of the script.
workers_schemas-version_identifier
string
workers_api-response-common-failure
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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