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

The Hyperdrive API from APIs.io Engineering Platform — 2 operation(s) for hyperdrive.

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

6 operations 2 paths 14 schemas 1 DELETE2 GET1 PATCH1 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 Hyperdrive 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 6

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

Hyperdrive 6
GET
/accounts/{account_id}/hyperdrive/configs
APIs.io Engineering Platform List Hyperdrives
list-hyperdrive 1 param → 4XX200
POST
/accounts/{account_id}/hyperdrive/configs
APIs.io Engineering Platform Create Hyperdrive
create-hyperdrive 1 param body → 4XX200
DELETE
/accounts/{account_id}/hyperdrive/configs/{hyperdrive_id}
APIs.io Engineering Platform Delete Hyperdrive
delete-hyperdrive 2 params → 4XX200
GET
/accounts/{account_id}/hyperdrive/configs/{hyperdrive_id}
APIs.io Engineering Platform Get Hyperdrive
get-hyperdrive 2 params → 4XX200
PATCH
/accounts/{account_id}/hyperdrive/configs/{hyperdrive_id}
APIs.io Engineering Platform Patch Hyperdrive
patch-hyperdrive 2 params body → 4XX200
PUT
/accounts/{account_id}/hyperdrive/configs/{hyperdrive_id}
APIs.io Engineering Platform Update Hyperdrive
update-hyperdrive 2 params body → 4XX200

Schemas 14

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

hyperdrive_api-response-single
object
hyperdrive_hyperdrive-with-identifier
object
1 property
hyperdrive_api-response-common-failure
object
4 properties 4 required
hyperdrive_identifier
string
Identifier
hyperdrive_messages
array
hyperdrive_hyperdrive-scheme
string
Specifies the URL scheme used to connect to your origin database.
hyperdrive_api-response-common
object
4 properties 4 required
hyperdrive_hyperdrive
object
3 properties
hyperdrive_create-update-hyperdrive-config
object
1 property 2 required
hyperdrive_hyperdrive-caching
object
3 properties
hyperdrive_hyperdrive-origin
object
6 properties 4 required
hyperdrive_patch-hyperdrive-config
object
1 property
hyperdrive_hyperdrive-name
string
hyperdrive_hyperdrive-origin-with-secrets
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-hyperdrive-api-openapi.yml Raw ↑