APIs.io Engineering Platform Restapis API
The Restapis API from APIs.io Engineering Platform — 30 operation(s) for restapis.
This API exposes 75 operations across 30 paths, and defines 91 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.
75 operations
30 paths
91 schemas
16 DELETE27 GET14 PATCH11 POST7 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
APIs.io Engineering Platform Restapis 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 75
Across 30 paths, the API surfaces 75 operations — 16 DELETE, 27 GET, 14 PATCH, 11 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.
Restapis 75
POST
/restapis/{restapi_id}/authorizers
Adds a new Authorizer resource to an existing RestApi resource.
GET
/restapis/{restapi_id}/authorizers
Describe an existing Authorizers resource.
POST
/restapis/{restapi_id}/deployments
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
GET
/restapis/{restapi_id}/deployments
Gets information about a Deployments collection.
POST
/restapis/{restapi_id}/documentation/parts
Creates a documentation part.
GET
/restapis/{restapi_id}/documentation/parts
Gets documentation parts.
PUT
/restapis/{restapi_id}/documentation/parts
Imports documentation parts
POST
/restapis/{restapi_id}/documentation/versions
Creates a documentation version
GET
/restapis/{restapi_id}/documentation/versions
Gets documentation versions.
POST
/restapis/{restapi_id}/models
Adds a new Model resource to an existing RestApi resource.
GET
/restapis/{restapi_id}/models
Describes existing Models defined for a RestApi resource.
POST
/restapis/{restapi_id}/requestvalidators
Creates a RequestValidator of a given RestApi.
GET
/restapis/{restapi_id}/requestvalidators
Gets the RequestValidators collection of a given RestApi.
POST
/restapis/{restapi_id}/resources/{parent_id}
Creates a Resource resource.
POST
/restapis
Creates a new RestApi resource.
GET
/restapis
Lists the RestApis resources for your collection.
POST
/restapis/{restapi_id}/stages
Creates a new Stage resource that references a pre-existing Deployment for the API.
GET
/restapis/{restapi_id}/stages
Gets information about one or more Stage resources.
DELETE
/restapis/{restapi_id}/authorizers/{authorizer_id}
Deletes an existing Authorizer resource.
GET
/restapis/{restapi_id}/authorizers/{authorizer_id}
Describe an existing Authorizer resource.
POST
/restapis/{restapi_id}/authorizers/{authorizer_id}
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
PATCH
/restapis/{restapi_id}/authorizers/{authorizer_id}
Updates an existing Authorizer resource.
DELETE
/restapis/{restapi_id}/deployments/{deployment_id}
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
GET
/restapis/{restapi_id}/deployments/{deployment_id}
Gets information about a Deployment resource.
PATCH
/restapis/{restapi_id}/deployments/{deployment_id}
Changes information about a Deployment resource.
DELETE
/restapis/{restapi_id}/documentation/parts/{part_id}
Deletes a documentation part
GET
/restapis/{restapi_id}/documentation/parts/{part_id}
Gets a documentation part.
PATCH
/restapis/{restapi_id}/documentation/parts/{part_id}
Updates a documentation part.
DELETE
/restapis/{restapi_id}/documentation/versions/{doc_version}
Deletes a documentation version.
GET
/restapis/{restapi_id}/documentation/versions/{doc_version}
Gets a documentation version.
PATCH
/restapis/{restapi_id}/documentation/versions/{doc_version}
Updates a documentation version.
DELETE
/restapis/{restapi_id}/gatewayresponses/{response_type}
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
GET
/restapis/{restapi_id}/gatewayresponses/{response_type}
Gets a GatewayResponse of a specified response type on the given RestApi.
PUT
/restapis/{restapi_id}/gatewayresponses/{response_type}
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
PATCH
/restapis/{restapi_id}/gatewayresponses/{response_type}
Updates a GatewayResponse of a specified response type on the given RestApi.
DELETE
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration
Represents a delete integration.
GET
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration
Get the integration settings.
PUT
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration
Sets up a method's integration.
PATCH
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration
Represents an update integration.
DELETE
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}
Represents a delete integration response.
GET
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}
Represents a get integration response.
PUT
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}
Represents a put integration.
PATCH
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}
Represents an update integration response.
DELETE
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}
Deletes an existing Method resource.
GET
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}
Describe an existing Method resource.
PUT
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}
Add a method to an existing Resource resource.
POST
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}
Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
PATCH
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}
Updates an existing Method resource.
DELETE
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}
Deletes an existing MethodResponse resource.
GET
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}
Describes a MethodResponse resource.
PUT
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}
Adds a MethodResponse to an existing Method resource.
PATCH
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}
Updates an existing MethodResponse resource.
DELETE
/restapis/{restapi_id}/models/{model_name}
Deletes a model.
GET
/restapis/{restapi_id}/models/{model_name}
Describes an existing model defined for a RestApi resource.
PATCH
/restapis/{restapi_id}/models/{model_name}
Changes information about a model.
DELETE
/restapis/{restapi_id}/requestvalidators/{requestvalidator_id}
Deletes a RequestValidator of a given RestApi.
GET
/restapis/{restapi_id}/requestvalidators/{requestvalidator_id}
Gets a RequestValidator of a given RestApi.
PATCH
/restapis/{restapi_id}/requestvalidators/{requestvalidator_id}
Updates a RequestValidator of a given RestApi.
DELETE
/restapis/{restapi_id}/resources/{resource_id}
Deletes a Resource resource.
GET
/restapis/{restapi_id}/resources/{resource_id}
Lists information about a resource.
PATCH
/restapis/{restapi_id}/resources/{resource_id}
Changes information about a Resource resource.
DELETE
/restapis/{restapi_id}
Deletes the specified API.
GET
/restapis/{restapi_id}
Lists the RestApi resource in the collection.
PUT
/restapis/{restapi_id}
A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing…
PATCH
/restapis/{restapi_id}
Changes information about the specified API.
DELETE
/restapis/{restapi_id}/stages/{stage_name}
Deletes a Stage resource.
GET
/restapis/{restapi_id}/stages/{stage_name}
Gets information about a Stage resource.
PATCH
/restapis/{restapi_id}/stages/{stage_name}
Changes information about a Stage resource.
DELETE
/restapis/{restapi_id}/stages/{stage_name}/cache/authorizers
Flushes all authorizer cache entries on a stage.
DELETE
/restapis/{restapi_id}/stages/{stage_name}/cache/data
Flushes a stage's cache.
GET
/restapis/{restapi_id}/stages/{stage_name}/exports/{export_type}
Exports a deployed version of a RestApi in a specified format.
GET
/restapis/{restapi_id}/gatewayresponses
Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayRespons…
GET
/restapis/{restapi_id}/models/{model_name}/default_template
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
GET
/restapis/{restapi_id}/resources
Lists information about a collection of Resource resources.
GET
/restapis/{restapi_id}/stages/{stage_name}/sdks/{sdk_type}
Generates a client SDK for a RestApi and Stage.
Schemas 91
The contract defines 91 schemas that model the data the API accepts and returns. The most detailed are Stage (17 properties), Integration (15 properties), RestApi (13 properties), Method (11 properties). Each schema is shown below with its type and property counts.
ListOfAuthorizer
array
TooManyRequestsException
NotFoundException
Integration
object
Represents an HTTP, HTTPPROXY, AWS, AWSPROXY, or Mock integration.
15 properties
ServiceUnavailableException
MapOfIntegrationResponse
object
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…
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
Stage
object
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
17 properties
RequestValidator
object
A set of validation rules for incoming Method requests.
4 properties
Timestamp
string
MapOfMethodResponse
object
ListOfModel
array
CanarySettings
object
Configuration settings of a canary deployment.
4 properties
RequestValidators
object
A collection of RequestValidator resources of a given RestApi.
2 properties
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
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
ListOfGatewayResponse
array
PathToMapOfMethodSnapshot
object
Models
object
Represents a collection of Model resources.
2 properties
MapOfStringToString
object
Resource
object
Represents an API resource.
5 properties
TestInvokeAuthorizerResponse
object
Represents the response of the test invoke request for a custom Authorizer
7 properties
DocumentationPartIds
object
A collection of the imported DocumentationPart identifiers.
2 properties
Stages
object
A list of Stage resources that are associated with the ApiKey resource.
1 property
ExportResponse
object
The binary blob response to GetExport, which contains the generated SDK.
1 property
MapOfMethodSettings
object
MapOfMethod
object
Double
number
ConnectionType
string
GatewayResponse
object
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
5 properties
Boolean
boolean
ConflictException
MethodSnapshot
object
Represents a summary of a Method resource, given a particular date and time.
2 properties
CacheClusterStatus
string
Returns the status of the CacheCluster.
ListOfEndpointType
array
NullableBoolean
boolean
GatewayResponseType
string
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
ApiKeySourceType
string
AccessLogSettings
object
Access log settings, including the access log format and access log destination ARN.
2 properties
DocumentationPartLocationStatusCode
string
Model
object
Represents the data structure of a method's request or response payload.
5 properties
DocumentationPartLocation
object
Specifies the target API entity to which the documentation applies.
5 properties
1 required
DocumentationParts
object
The collection of documentation parts of an API.
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…
DocumentationVersions
object
The collection of documentation snapshots of an API.
2 properties
NullableInteger
integer
Op
string
UnauthorizedException
SdkResponse
object
The binary blob response to GetSdk, which contains the generated SDK.
1 property
Long
integer
ListOfARNs
array
Authorizers
object
Represents a collection of Authorizer resources.
2 properties
PatchOperation
object
For more information about supported patch operations, see Patch Operations .
4 properties
ListOfDocumentationVersion
array
Resources
object
Represents a collection of Resource resources.
2 properties
DocumentationPart
object
A documentation part for a targeted API entity.
3 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…
String
string
MapOfMethodSnapshot
object
CacheClusterSize
string
Returns the size of the CacheCluster.
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
ContentHandlingStrategy
string
MapOfStringToBoolean
object
ListOfDocumentationPart
array
EndpointConfiguration
object
The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
2 properties
ProviderARN
string
StatusCode
string
The status code.
DocumentationVersion
object
A snapshot of the documentation of an API.
3 properties
ListOfDeployment
array
ListOfStage
array
Integer
integer
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
RestApi
object
Represents a REST API.
13 properties
Template
object
Represents a mapping template used to transform a payload.
1 property
BadRequestException
LimitExceededException
DocumentationPartType
string
ListOfResource
array
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
MethodSetting
object
Specifies the method setting properties.
10 properties
ListOfString
array
TestInvokeMethodResponse
object
Represents the response of the test invoke request in the HTTP method.
6 properties
TlsConfig
object
Specifies the TLS configuration for an integration.
1 property
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
ListOfRestApi
array
MapOfStringToList
object
ListOfRequestValidator
array
Blob
string
UnauthorizedCacheControlHeaderStrategy
string
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Restapis