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 Stream Signing Keys API

The Stream Signing Keys API from APIs.io Engineering Platform — 2 operation(s) for stream signing keys.

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

3 operations 2 paths 12 schemas 1 DELETE1 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 Stream Signing Keys 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 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Stream Signing Keys 3
GET
/accounts/{account_id}/stream/keys
APIs.io Engineering Platform List signing keys
stream-signing-keys-list-signing-keys 1 param → 4XX200
POST
/accounts/{account_id}/stream/keys
APIs.io Engineering Platform Create signing keys
stream-signing-keys-create-signing-keys 1 param body → 4XX200
DELETE
/accounts/{account_id}/stream/keys/{identifier}
APIs.io Engineering Platform Delete signing keys
stream-signing-keys-delete-signing-keys 2 params body → 4XX200

Schemas 12

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

stream_keys
object
4 properties
stream_schemas-identifier
string
Identifier
stream_signing_key_created
string
The date and time a signing key was created.
stream_key_generation_response
stream_key_response_collection
stream_deleted_response
stream_api-response-common-failure
object
4 properties 4 required
stream_api-response-common
object
3 properties 3 required
stream_pem
string
The signing key in PEM format.
stream_messages
array
stream_jwk
string
The signing key in JWK format.
stream_api-response-single
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-stream-signing-keys-api-openapi.yml Raw ↑