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 Sinkhole Config API

The Sinkhole Config API from APIs.io Engineering Platform — 1 operation(s) for sinkhole config.

This API exposes 1 operation across 1 path, and defines 7 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.

1 operations 1 paths 7 schemas 1 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 Sinkhole Config 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 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Sinkhole Config 1
GET
/accounts/{account_id}/intel/sinkholes
APIs.io Engineering Platform List sinkholes owned by this account
sinkhole-config-get-sinkholes 1 param → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are intel-sinkholes_sinkhole_item (7 properties), intel-sinkholes_api-response-common (3 properties). Each schema is shown below with its type and property counts.

intel-sinkholes_id
integer
The unique identifier for the sinkhole
intel-sinkholes_identifier
string
Identifier
intel-sinkholes_messages
array
intel-sinkholes_api-response-common
object
3 properties 3 required
intel-sinkholes_get_sinkholes_response
intel-sinkholes_sinkhole_item
object
7 properties
intel-sinkholes_name
string
The name of the sinkhole

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-sinkhole-config-api-openapi.yml Raw ↑