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

The Apis API from APIs.io Engineering Platform — 4 operation(s) for apis.

This API exposes 7 operations across 4 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.

7 operations 4 paths 12 schemas 1 DELETE4 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 Apis 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 7

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

Apis 7
GET
/apis
APIs.io Engineering Platform Get all APIs
getApis 7 params → 200401403404422500
POST
/apis
APIs.io Engineering Platform Create an API
createApi 2 params body → 200400401403404500
GET
/apis/{apiId}
APIs.io Engineering Platform Get an API
getApi 3 params → 200400401403404422500
PUT
/apis/{apiId}
APIs.io Engineering Platform Update an API
updateApi 2 params body → 200400401403404422500
DELETE
/apis/{apiId}
APIs.io Engineering Platform Delete an API
deleteApi 2 params → 204400401403404422500
GET
/apis/{apiId}/tasks/{taskId}
APIs.io Engineering Platform Get status of an asynchronous task
getStatusOfAnAsyncTask 3 params → 200400401403404500
GET
/apis/{apiId}/versions/{versionId}
APIs.io Engineering Platform Get a version
getApiVersion 3 params → 200302400401403404500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are api403ErrorLimitReached (4 properties), featureUnavailable403Error (4 properties), taskNotFound (3 properties), api404ErrorNotFound (3 properties). Each schema is shown below with its type and property counts.

taskNotFound
object
3 properties
apiVersion404ErrorNotFound
object
3 properties
v10HeaderMissing
object
2 properties
apiVersion400ErrorInvalidParam
object
3 properties
apiVersionId
string
api404ErrorNotFound
object
3 properties
workspaceId
string
featureUnavailable403Error
object
4 properties
limit
integer
api403ErrorLimitReached
object
4 properties
cursor
string
api403ErrorForbidden
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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