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 (Deprecated) API

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

This API exposes 2 operations across 2 paths, and defines 9 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 2 paths 9 schemas 2 GET

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 (Deprecated) 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 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Worker Deployments (Deprecated) 2
GET
/accounts/{account_id}/workers/deployments/by-script/{script_id}deprecated
APIs.io Engineering Platform List Deployments
worker-deployments-(-deprecated)-list-deployments 2 params → 4XX200
GET
/accounts/{account_id}/workers/deployments/by-script/{script_id}/detail/{deployment_id}deprecated
APIs.io Engineering Platform Get Deployment Detail
worker-deployments-(-deprecated)-get-deployment-detail 3 params → 4XX200

Schemas 9

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

workers_version-item-short
object
3 properties
workers_identifier
string
Identifier
workers_deployments-list-response
workers_messages
array
workers_script_identifier
string
workers_api-response-common
object
3 properties 3 required
workers_deployment_identifier
string
workers_api-response-common-failure
object
4 properties 4 required
workers_deployments-single-response

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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