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

The **API Versions** endpoints enable you to manage your [API's versions](https://learning.postman.com/docs/designing-and-developing-your-api/versioning-an-api/versioning-an-api-overview/#publishing-an-api-version). Only users with the [API Admin](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#api-roles) or [Workspace Admin](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#workspace-roles) role can publish and manage versions.

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

4 operations 2 paths 10 schemas 1 DELETE1 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 API Versions 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 4

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

API Versions 4

The API Versions endpoints enable you to manage your [API's versions](https://learning.postman.com/docs/designing-and-developing-your-api/versioning-an-api/versioning-an-api-overv…

GET
/apis/{apiId}/versions
APIs.io Engineering Platform Get all versions
getApiVersions 4 params → 200401403404422500
POST
/apis/{apiId}/versions
APIs.io Engineering Platform Create a version
createApiVersion 2 params body → 202401403404422500
PUT
/apis/{apiId}/versions/{versionId}
APIs.io Engineering Platform Update a version
updateApiVersion 3 params body → 200400401403404500
DELETE
/apis/{apiId}/versions/{versionId}
APIs.io Engineering Platform Delete a version
deleteApiVersion 3 params → 204400401403404500

Schemas 10

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

apiVersion404ErrorNotFound
object
3 properties
v10HeaderMissing
object
2 properties
apiVersionId
string
api404ErrorNotFound
object
3 properties
featureUnavailable403Error
object
4 properties
limit
integer
apiSchema403ErrorForbidden
object
3 properties
cursor
string
api403ErrorForbidden
object
3 properties
apiVersion400ErrorInstanceNotFound
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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