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

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

This API exposes 4 operations across 2 paths, and defines 13 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 13 schemas 1 DELETE2 GET1 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 Domain 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 — 1 DELETE, 2 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Worker Domain 4
GET
/accounts/{account_id}/workers/domains
APIs.io Engineering Platform List Domains
worker-domain-list-domains 6 params → 4XX200
PUT
/accounts/{account_id}/workers/domains
APIs.io Engineering Platform Attach to Domain
worker-domain-attach-to-domain 1 param body → 4XX200
DELETE
/accounts/{account_id}/workers/domains/{domain_id}
APIs.io Engineering Platform Detach from Domain
worker-domain-detach-from-domain 2 params body → 4XX200
GET
/accounts/{account_id}/workers/domains/{domain_id}
APIs.io Engineering Platform Get a Domain
worker-domain-get-a-domain 2 params → 4XX200

Schemas 13

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

workers_domain
object
6 properties
workers_hostname
string
Hostname of the Worker Domain.
workers_domain-response-collection
workers_domain-response-single
workers_zone_identifier
string
Identifier of the zone.
workers_messages
array
workers_domain_identifier
string
Identifer of the Worker Domain.
workers_account_identifier
string
Identifer of the account.
workers_api-response-common
object
3 properties 3 required
workers_schemas-service
string
Worker service associated with the zone and hostname.
workers_schemas-environment
string
Worker environment associated with the zone and hostname.
workers_api-response-common-failure
object
4 properties 4 required
workers_zone_name
string
Name of the zone.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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