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

The Accounts API from APIs.io Engineering Platform — 2 operation(s) for accounts.

This API exposes 5 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.

5 operations 2 paths 14 schemas 1 DELETE2 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 Accounts 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 5

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

Accounts 5
GET
/accounts
APIs.io Engineering Platform List Accounts
accounts-list-accounts 4 params → 4XX200
POST
/accounts
APIs.io Engineering Platform Create an account
account-creation body → 4XX200
DELETE
/accounts/{account_id}
APIs.io Engineering Platform Delete a specific account
account-deletion 1 param → 4XX200
GET
/accounts/{account_id}
APIs.io Engineering Platform Account Details
accounts-account-details 1 param → 4XX200
PUT
/accounts/{account_id}
APIs.io Engineering Platform Update Account
accounts-update-account 1 param body → 4XX200

Schemas 14

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

iam_response_collection_accounts
iam_common_components-schemas-identifier
string
Identifier
iam_account_identifier
string
Account identifier tag.
iam_api-response-single-id
object
iam_api-response-collection
object
iam_account
object
4 properties 2 required
iam_result_info
object
4 properties
iam_api-response-single
object
iam_api-response-common
object
3 properties 3 required
iam_response_single_account
iam_components-schemas-account
iam_create-account
object
3 properties 2 required
iam_api-response-common-failure
object
4 properties 4 required
iam_messages
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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