APIs.io Engineering Platform REST APIs API is one of 309 APIs that APIs.io Engineering Platform publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include REST API. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
75 operations
across 30 paths,
and defines 91 schemas.
It is described by OpenAPI 3.2.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.
The identity and technical contract details declared by the specification.
ExportResponse
object
The binary blob response to GetExport, which contains the generated SDK.
1 property
MapOfMethodSnapshot
object
ListOfDocumentationPart
array
MethodSnapshot
object
Represents a summary of a Method resource, given a particular date and time.
2 properties
Integration
object
Represents an HTTP, HTTPPROXY, AWS, AWSPROXY, or Mock integration.
15 properties
Stage
object
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
17 properties
ListOfGatewayResponse
array
UnauthorizedCacheControlHeaderStrategy
string
GatewayResponse
object
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
5 properties
GatewayResponses
object
The collection of the GatewayResponse instances of a RestApi as a responseType -to-GatewayResponse object map of key-value pairs. As such, pagination is not su…
2 properties
Deployment
object
An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable…
4 properties
Authorizer
object
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
10 properties
RestApis
object
Contains references to your APIs and links that guide you in how to interact with your collection. A collection offers a paginated view of your APIs.
2 properties
IntegrationType
string
The integration type. The valid value is HTTP for integrating an API method with an HTTP backend; AWS with any AWS service endpoints; MOCK for testing without…
Deployments
object
Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your coll…
2 properties
MapOfMethodSettings
object
DocumentationPartIds
object
A collection of the imported DocumentationPart identifiers.
2 properties
Template
object
Represents a mapping template used to transform a payload.
1 property
Resource
object
Represents an API resource.
5 properties
CacheClusterSize
string
Returns the size of the CacheCluster.
IntegrationResponse
object
Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end…
5 properties
TestInvokeMethodResponse
object
Represents the response of the test invoke request in the HTTP method.
6 properties
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…
DocumentationPartLocation
object
Specifies the target API entity to which the documentation applies.
5 properties
1 required
Method
object
Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resour…
11 properties
MethodSetting
object
Specifies the method setting properties.
10 properties
ListOfDocumentationVersion
array
TestInvokeAuthorizerResponse
object
Represents the response of the test invoke request for a custom Authorizer
7 properties
MapOfMethodResponse
object
DocumentationParts
object
The collection of documentation parts of an API.
2 properties
Model
object
Represents the data structure of a method's request or response payload.
5 properties
DocumentationPartType
string
MapOfStringToString
object
GatewayResponseType
string
Stages
object
A list of Stage resources that are associated with the ApiKey resource.
1 property
DocumentationPartLocationStatusCode
string
Resources
object
Represents a collection of Resource resources.
2 properties
PatchOperation
object
For more information about supported patch operations, see Patch Operations .
4 properties
DocumentationVersions
object
The collection of documentation snapshots of an API.
2 properties
Authorizers
object
Represents a collection of Authorizer resources.
2 properties
MethodResponse
object
Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integra…
3 properties
CanarySettings
object
Configuration settings of a canary deployment.
4 properties
MapOfIntegrationResponse
object
EndpointConfiguration
object
The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
2 properties
RequestValidator
object
A set of validation rules for incoming Method requests.
4 properties
ListOfRequestValidator
array
ContentHandlingStrategy
string
PathToMapOfMethodSnapshot
object
ServiceUnavailableException
Models
object
Represents a collection of Model resources.
2 properties
RestApi
object
Represents a REST API.
13 properties
MapOfStringToBoolean
object
DocumentationVersion
object
A snapshot of the documentation of an API.
3 properties
CacheClusterStatus
string
Returns the status of the CacheCluster.
AccessLogSettings
object
Access log settings, including the access log format and access log destination ARN.
2 properties
AuthorizerType
string
The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda functio…
DocumentationPart
object
A documentation part for a targeted API entity.
3 properties
StatusCode
string
The status code.
SdkResponse
object
The binary blob response to GetSdk, which contains the generated SDK.
1 property
TlsConfig
object
Specifies the TLS configuration for an integration.
1 property
RequestValidators
object
A collection of RequestValidator resources of a given RestApi.
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs APIs.io Engineering Platform publishes across the network.