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

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

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

2 operations 1 paths 14 schemas 1 GET1 PATCH

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 Account 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 PATCH. Each is listed below with its method, path, parameters, and response codes.

Account 2
GET
/account
Gets information about the current Account resource.
GetAccount 7 params → 200480481482483
PATCH
/account
Changes information about the current Account resource.
UpdateAccount 7 params body → 200480481482483484485

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Account (4 properties), PatchOperation (4 properties), ThrottleSettings (2 properties). Each schema is shown below with its type and property counts.

TooManyRequestsException
NotFoundException
Op
string
Double
number
Integer
integer
UnauthorizedException
ConflictException
BadRequestException
PatchOperation
object
For more information about supported patch operations, see Patch Operations .
4 properties
LimitExceededException
String
string
ListOfString
array
ThrottleSettings
object
The API request rate limits.
2 properties
Account
object
Represents an AWS account that is associated with API Gateway.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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