How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform REST APIs API

The REST APIs API from APIs.io Engineering Platform — 30 operation(s) for rest apis.

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.

75 operations 30 paths 91 schemas 16 DELETE27 GET14 PATCH11 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2015-07-09
Base URL
https://rds.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform REST 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 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.

REST APIs 75
POST
/restapis/{restapi_id}/authorizers
Create authorizer
CreateAuthorizer 8 params body → 201480481482483484485
GET
/restapis/{restapi_id}/authorizers
Get authorizers
GetAuthorizers 10 params → 200480481482483
POST
/restapis/{restapi_id}/deployments
Create deployment
CreateDeployment 8 params body → 201480481482483484485486
GET
/restapis/{restapi_id}/deployments
Get deployments
GetDeployments 10 params → 200480481482483484
POST
/restapis/{restapi_id}/documentation/parts
Create documentation part
CreateDocumentationPart 8 params body → 201480481482483484485
GET
/restapis/{restapi_id}/documentation/parts
Get documentation parts
GetDocumentationParts 14 params → 200480481482483
PUT
/restapis/{restapi_id}/documentation/parts
Import documentation parts
ImportDocumentationParts 10 params body → 200480481482483484485
POST
/restapis/{restapi_id}/documentation/versions
Create documentation version
CreateDocumentationVersion 8 params body → 201480481482483484485
GET
/restapis/{restapi_id}/documentation/versions
Get documentation versions
GetDocumentationVersions 10 params → 200480481482483
POST
/restapis/{restapi_id}/models
Create model
CreateModel 8 params body → 201480481482483484485
GET
/restapis/{restapi_id}/models
Get models
GetModels 10 params → 200480481482483
POST
/restapis/{restapi_id}/requestvalidators
Create request validator
CreateRequestValidator 8 params body → 201480481482483484485
GET
/restapis/{restapi_id}/requestvalidators
Get request validators
GetRequestValidators 10 params → 200480481482483
POST
/restapis/{restapi_id}/resources/{parent_id}
Create resource
CreateResource 9 params body → 201480481482483484485
POST
/restapis
Create rest api
CreateRestApi 7 params body → 201480481482483484
GET
/restapis
Get rest apis
GetRestApis 9 params → 200480481482483
POST
/restapis/{restapi_id}/stages
Create stage
CreateStage 8 params body → 201480481482483484485
GET
/restapis/{restapi_id}/stages
Get stages
GetStages 9 params → 200480481482483484485
DELETE
/restapis/{restapi_id}/authorizers/{authorizer_id}
Delete authorizer
DeleteAuthorizer 9 params → 202480481482483484
GET
/restapis/{restapi_id}/authorizers/{authorizer_id}
Get authorizer
GetAuthorizer 9 params → 200480481482483
POST
/restapis/{restapi_id}/authorizers/{authorizer_id}
Test invoke authorizer
TestInvokeAuthorizer 9 params body → 200480481482483
PATCH
/restapis/{restapi_id}/authorizers/{authorizer_id}
Update authorizer
UpdateAuthorizer 9 params body → 200480481482483484485
DELETE
/restapis/{restapi_id}/deployments/{deployment_id}
Delete deployment
DeleteDeployment 9 params → 202480481482483484485
GET
/restapis/{restapi_id}/deployments/{deployment_id}
Get deployment
GetDeployment 10 params → 200480481482483484
PATCH
/restapis/{restapi_id}/deployments/{deployment_id}
Update deployment
UpdateDeployment 9 params body → 200480481482483484485486
DELETE
/restapis/{restapi_id}/documentation/parts/{part_id}
Delete documentation part
DeleteDocumentationPart 9 params → 202480481482483484
GET
/restapis/{restapi_id}/documentation/parts/{part_id}
Get documentation part
GetDocumentationPart 9 params → 200480481482483
PATCH
/restapis/{restapi_id}/documentation/parts/{part_id}
Update documentation part
UpdateDocumentationPart 9 params body → 200480481482483484485
DELETE
/restapis/{restapi_id}/documentation/versions/{doc_version}
Delete documentation version
DeleteDocumentationVersion 9 params → 202480481482483484
GET
/restapis/{restapi_id}/documentation/versions/{doc_version}
Get documentation version
GetDocumentationVersion 9 params → 200480481482
PATCH
/restapis/{restapi_id}/documentation/versions/{doc_version}
Update documentation version
UpdateDocumentationVersion 9 params body → 200480481482483484485
DELETE
/restapis/{restapi_id}/gatewayresponses/{response_type}
Delete gateway response
DeleteGatewayResponse 9 params → 202480481482483484
GET
/restapis/{restapi_id}/gatewayresponses/{response_type}
Get gateway response
GetGatewayResponse 9 params → 200480481482483
PUT
/restapis/{restapi_id}/gatewayresponses/{response_type}
Put gateway response
PutGatewayResponse 9 params body → 201480481482483484485
PATCH
/restapis/{restapi_id}/gatewayresponses/{response_type}
Update gateway response
UpdateGatewayResponse 9 params body → 200480481482483484485
DELETE
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration
Delete integration
DeleteIntegration 10 params → 204480481482483484
GET
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration
Get integration
GetIntegration 10 params → 200480481482483
PUT
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration
Put integration
PutIntegration 10 params body → 201480481482483484485
PATCH
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration
Update integration
UpdateIntegration 10 params body → 200480481482483484485
DELETE
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}
Delete integration response
DeleteIntegrationResponse 11 params → 204480481482483484
GET
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}
Get integration response
GetIntegrationResponse 11 params → 200480481482483
PUT
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}
Put integration response
PutIntegrationResponse 11 params body → 201480481482483484485
PATCH
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}
Update integration response
UpdateIntegrationResponse 11 params body → 200480481482483484485
DELETE
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}
Delete method
DeleteMethod 10 params → 204480481482483
GET
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}
Get method
GetMethod 10 params → 200480481482
PUT
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}
Put method
PutMethod 10 params body → 201480481482483484485
POST
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}
Test invoke method
TestInvokeMethod 10 params body → 200480481482483
PATCH
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}
Update method
UpdateMethod 10 params body → 200480481482483484
DELETE
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}
Delete method response
DeleteMethodResponse 11 params → 204480481482483484
GET
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}
Get method response
GetMethodResponse 11 params → 200480481482
PUT
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}
Put method response
PutMethodResponse 11 params body → 201480481482483484485
PATCH
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}
Update method response
UpdateMethodResponse 11 params body → 201480481482483484485
DELETE
/restapis/{restapi_id}/models/{model_name}
Delete model
DeleteModel 9 params → 202480481482483484
GET
/restapis/{restapi_id}/models/{model_name}
Get model
GetModel 10 params → 200480481482483
PATCH
/restapis/{restapi_id}/models/{model_name}
Update model
UpdateModel 9 params body → 200480481482483484485
DELETE
/restapis/{restapi_id}/requestvalidators/{requestvalidator_id}
Delete request validator
DeleteRequestValidator 9 params → 202480481482483484
GET
/restapis/{restapi_id}/requestvalidators/{requestvalidator_id}
Get request validator
GetRequestValidator 9 params → 200480481482483
PATCH
/restapis/{restapi_id}/requestvalidators/{requestvalidator_id}
Update request validator
UpdateRequestValidator 9 params body → 200480481482483484485
DELETE
/restapis/{restapi_id}/resources/{resource_id}
Delete resource
DeleteResource 9 params → 202480481482483484
GET
/restapis/{restapi_id}/resources/{resource_id}
Get resource
GetResource 10 params → 200480481482
PATCH
/restapis/{restapi_id}/resources/{resource_id}
Update resource
UpdateResource 9 params body → 200480481482483484
DELETE
/restapis/{restapi_id}
Delete rest api
DeleteRestApi 8 params → 202480481482483484
GET
/restapis/{restapi_id}
Get rest api
GetRestApi 8 params → 200480481482483
PUT
/restapis/{restapi_id}
Put rest api
PutRestApi 11 params body → 200480481482483484485
PATCH
/restapis/{restapi_id}
Update rest api
UpdateRestApi 8 params body → 200480481482483484485
DELETE
/restapis/{restapi_id}/stages/{stage_name}
Delete stage
DeleteStage 9 params → 202480481482483484485
GET
/restapis/{restapi_id}/stages/{stage_name}
Get stage
GetStage 9 params → 200480481482483484485
PATCH
/restapis/{restapi_id}/stages/{stage_name}
Update stage
UpdateStage 9 params body → 200480481482483484485
DELETE
/restapis/{restapi_id}/stages/{stage_name}/cache/authorizers
Flush stage authorizers cache
FlushStageAuthorizersCache 9 params → 202480481482483484485
DELETE
/restapis/{restapi_id}/stages/{stage_name}/cache/data
Flush stage cache
FlushStageCache 9 params → 202480481482483484485
GET
/restapis/{restapi_id}/stages/{stage_name}/exports/{export_type}
Get export
GetExport 12 params → 200480481482483484485
GET
/restapis/{restapi_id}/gatewayresponses
Get gateway responses
GetGatewayResponses 10 params → 200480481482483
GET
/restapis/{restapi_id}/models/{model_name}/default_template
Get model template
GetModelTemplate 9 params → 200480481482483
GET
/restapis/{restapi_id}/resources
Get resources
GetResources 11 params → 200480481482483
GET
/restapis/{restapi_id}/stages/{stage_name}/sdks/{sdk_type}
Get sdk
GetSdk 11 params → 200480481482483484485

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.

ExportResponse
object
The binary blob response to GetExport, which contains the generated SDK.
1 property
MapOfMethodSnapshot
object
ListOfDocumentationPart
array
Double
number
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
Integer
integer
ListOfDeployment
array
NullableBoolean
boolean
Stage
object
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
17 properties
MapOfStringToList
object
LimitExceededException
NullableInteger
integer
ListOfGatewayResponse
array
ConflictException
UnauthorizedCacheControlHeaderStrategy
string
ListOfRestApi
array
GatewayResponse
object
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
5 properties
ListOfARNs
array
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
Blob
string
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
ListOfString
array
MethodSetting
object
Specifies the method setting properties.
10 properties
String
string
ListOfDocumentationVersion
array
TestInvokeAuthorizerResponse
object
Represents the response of the test invoke request for a custom Authorizer
7 properties
ListOfEndpointType
array
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
Boolean
boolean
DocumentationPartType
string
MapOfStringToString
object
ListOfResource
array
GatewayResponseType
string
Stages
object
A list of Stage resources that are associated with the ApiKey resource.
1 property
DocumentationPartLocationStatusCode
string
ConnectionType
string
MapOfMethod
object
Op
string
ListOfModel
array
Resources
object
Represents a collection of Resource resources.
2 properties
PatchOperation
object
For more information about supported patch operations, see Patch Operations .
4 properties
NotFoundException
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
ListOfAuthorizer
array
PathToMapOfMethodSnapshot
object
Long
integer
ListOfStage
array
ApiKeySourceType
string
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
ProviderARN
string
TooManyRequestsException
StatusCode
string
The status code.
BadRequestException
Timestamp
string
UnauthorizedException
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs APIs.io Engineering Platform publishes across the network.

Amazon Relational Database Service
Amazon Simple Storage Service
EasyCron
APIs.io Engineering Platform Access Application-Scoped Policies API
APIs.io Engineering Platform Access Applications API
APIs.io Engineering Platform Access Authentication Logs API
APIs.io Engineering Platform Access Bookmark Applications (Deprecated) API
APIs.io Engineering Platform Access Custom Pages API
APIs.io Engineering Platform Access Groups API
APIs.io Engineering Platform Access Identity Providers API
APIs.io Engineering Platform Access Key Configuration API
Where this information came from

This is an independent, third-party profile of APIs.io Engineering Platform REST APIs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.