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 Account Settings API

The Worker Account Settings API from APIs.io Engineering Platform — 1 operation(s) for worker account settings.

This API exposes 2 operations across 1 path, and defines 6 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 6 schemas 1 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 Account Settings 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 PUT. Each is listed below with its method, path, parameters, and response codes.

Worker Account Settings 2
GET
/accounts/{account_id}/workers/account-settings
APIs.io Engineering Platform Fetch Worker Account Settings
worker-account-settings-fetch-worker-account-settings 1 param → 4XX200
PUT
/accounts/{account_id}/workers/account-settings
APIs.io Engineering Platform Create Worker Account Settings
worker-account-settings-create-worker-account-settings 1 param body → 4XX200

Schemas 6

The contract defines 6 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_account-settings (2 properties). Each schema is shown below with its type and property counts.

workers_identifier
string
Identifier
workers_account-settings
object
2 properties
workers_messages
array
workers_api-response-common
object
3 properties 3 required
workers_account-settings-response
workers_api-response-common-failure
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-worker-account-settings-api-openapi.yml Raw ↑