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 Access Key Configuration API

The Access Key Configuration API from APIs.io Engineering Platform — 2 operation(s) for access key configuration.

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

3 operations 2 paths 10 schemas 1 GET1 POST1 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 Access Key Configuration 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 3

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

Access Key Configuration 3
GET
/accounts/{account_id}/access/keys
APIs.io Engineering Platform Get the Access key configuration
access-key-configuration-get-the-access-key-configuration 1 param → 4XX200
PUT
/accounts/{account_id}/access/keys
APIs.io Engineering Platform Update the Access key configuration
access-key-configuration-update-the-access-key-configuration 1 param body → 4XX200
POST
/accounts/{account_id}/access/keys/rotate
APIs.io Engineering Platform Rotate Access keys
access-key-configuration-rotate-access-keys 1 param → 4XX200

Schemas 10

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

access_last_key_rotation_at
string
The timestamp of the previous key rotation.
access_api-response-common
object
3 properties 3 required
access_api-response-common-failure
object
4 properties 4 required
access_keys_components-schemas-single_response
access_messages
array
access_days_until_next_rotation
number
The number of days until the next key rotation.
access_key_rotation_interval_days
number
The number of days between key rotations.
access_key_config
object
3 properties
access_api-response-single
object
access_identifier
string
Identifier

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-access-key-configuration-api-openapi.yml Raw ↑