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 Restapis#mode=import API

The Restapis#mode=import API from APIs.io Engineering Platform — 1 operation(s) for restapis#mode=import.

This API exposes 1 operation across 1 path, and defines 17 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.

1 operations 1 paths 17 schemas 1 POST

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 Restapis#mode=import 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Restapis#mode=import 1
POST
/restapis#mode=import
A feature of the API Gateway control service for creating a new API from an external API definition file.
ImportRestApi 10 params body → 201480481482483484485

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are RestApi (13 properties), EndpointConfiguration (2 properties). Each schema is shown below with its type and property counts.

TooManyRequestsException
NotFoundException
NullableInteger
integer
UnauthorizedException
RestApi
object
Represents a REST API.
13 properties
Boolean
boolean
ConflictException
Timestamp
string
BadRequestException
LimitExceededException
ListOfEndpointType
array
EndpointType
string
The endpoint type. The valid values are EDGE for edge-optimized API setup, most suitable for mobile applications; REGIONAL for regional API endpoint setup, mos…
String
string
ApiKeySourceType
string
ListOfString
array
MapOfStringToString
object
EndpointConfiguration
object
The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-restapis-mode-import-api-openapi.yml Raw ↑