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

Amazon API Gateway Methods API

Operations for managing HTTP methods on resources

Amazon API Gateway Methods API is one of 18 APIs that Amazon API Gateway publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 8 JSON Schema definitions.

Tagged areas include Methods. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, pricing, a getting-started guide, an API reference, a JSON-LD context, and 8 JSON Schemas.

This API exposes 6 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.1.0, at version 2015-07-09.

Requests are made against a single base URL, https://apigateway.{region}.amazonaws.com.

6 operations 2 paths 9 schemas 1 DELETE2 GET1 PATCH2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2015-07-09
Base URL
https://apigateway.{region}.amazonaws.com
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Amazon API Gateway Methods API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (sigv4). By default, every request must be authenticated.

  • sigv4 — AWS Signature Version 4 authentication

Paths & Operations 6

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

Methods 6

Operations for managing HTTP methods on resources

GET
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}
Amazon API Gateway Get a Method
GetMethod 3 params → 200404429
PUT
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}
Amazon API Gateway Create or Update a Method
PutMethod 3 params body → 201400404409429
PATCH
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}
Amazon API Gateway Update a Method
UpdateMethod 3 params body → 200404409429
DELETE
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}
Amazon API Gateway Delete a Method
DeleteMethod 3 params → 204404409429
GET
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration
Amazon API Gateway Get an Integration
GetIntegration 3 params → 200404429
PUT
/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration
Amazon API Gateway Create or Update an Integration
PutIntegration 3 params body → 201400404409429

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Integration (15 properties), PutIntegrationRequest (13 properties), Method (10 properties), PutMethodRequest (7 properties). Each schema is shown below with its type and property counts.

PutIntegrationRequest
object
13 properties 1 required
Integration
object
15 properties
Method
object
10 properties
IntegrationResponse
object
5 properties
PutMethodRequest
object
7 properties 1 required
PatchOperation
object
4 properties
PatchOperations
object
1 property
Error
object
2 properties
MethodResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-api-gateway-methods-api-openapi.yml Raw ↑

Other APIs Amazon API Gateway publishes across the network.

Amazon API Gateway WebSocket API
Amazon API Gateway HTTP API
Amazon API Gateway Management API
Amazon API Gateway API Keys API
Amazon API Gateway Authorizers API
Amazon API Gateway Base Path Mappings API
Amazon API Gateway Deployments API
Amazon API Gateway Documentation API
Amazon API Gateway Domain Names API
Amazon API Gateway Gateway Responses API
Amazon API Gateway Models API
Amazon API Gateway Request Validators API