API Gateway operations
Every API Gateway operation Overcast declares — 104 of 106 implemented — with status, behaviour notes and a link to the AWS API reference for each.
104 of 106 listed operations are implemented. Back to API Gateway.
Summary
| Category | ✅ Supported | ❌ Unsupported |
|---|---|---|
| REST API v1 management | 24 | |
| REST API v1 stages | 7 | |
| REST API v1 other | 34 | 2 |
| HTTP API v2 management | 15 | |
| HTTP API v2 stages | 6 | |
| HTTP API v2 other | 17 | |
| REST API v1 execution | 1 |
Endpoints
REST API v1 management
| Operation | Status | Notes | AWS Docs |
|---|---|---|---|
CreateRestApi | ✅ Supported | Creates API with root / resource; default EDGE endpoint type | docs |
GetRestApi | ✅ Supported | docs | |
GetRestApis | ✅ Supported | Pagination not yet implemented | docs |
DeleteRestApi | ✅ Supported | Cascade deletes resources, stages, and deployments | docs |
UpdateRestApi | ✅ Supported | Patch /name, /description, /policy, /disableExecuteApiEndpoint | docs |
CreateResource | ✅ Supported | Computes full path from parent chain | docs |
GetResource | ✅ Supported | docs | |
GetResources | ✅ Supported | Pagination not yet implemented | docs |
DeleteResource | ✅ Supported | docs | |
UpdateResource | ✅ Supported | Patch /pathPart | docs |
PutMethod | ✅ Supported | docs | |
GetMethod | ✅ Supported | docs | |
DeleteMethod | ✅ Supported | docs | |
UpdateMethod | ✅ Supported | Patch /authorizationType, /authorizerId, /apiKeyRequired | docs |
PutIntegration | ✅ Supported | AWS_PROXY/MOCK/HTTP_PROXY/HTTP/AWS types; uri, httpMethod | docs |
GetIntegration | ✅ Supported | docs | |
DeleteIntegration | ✅ Supported | docs | |
UpdateIntegration | ✅ Supported | Patch integrationType, integrationUri, payloadFormatVersion | docs |
PutMethodResponse | ✅ Supported | docs | |
GetMethodResponse | ✅ Supported | docs | |
DeleteMethodResponse | ✅ Supported | docs | |
PutIntegrationResponse | ✅ Supported | responseTemplates, selectionPattern | docs |
GetIntegrationResponse | ✅ Supported | docs | |
DeleteIntegrationResponse | ✅ Supported | docs |
REST API v1 stages
| Operation | Status | Notes | AWS Docs |
|---|---|---|---|
CreateDeployment | ✅ Supported | docs | |
GetDeployments | ✅ Supported | docs | |
CreateStage | ✅ Supported | Links to a deployment | docs |
GetStage | ✅ Supported | docs | |
GetStages | ✅ Supported | docs | |
UpdateStage | ✅ Supported | Patch /description, /deploymentId, and per-key /variables/{name} (replace/add/remove); MethodSettings, TracingEnabled, AccessLogSetting, CacheClusterEnabled/Size, ClientCertificateId, DocumentationVersion not implemented | docs |
DeleteStage | ✅ Supported | docs |
REST API v1 other
| Operation | Status | Notes | AWS Docs |
|---|---|---|---|
CreateModel | ✅ Supported | id, name, contentType, schema, description | docs |
GetModel | ✅ Supported | docs | |
GetModels | ✅ Supported | docs | |
DeleteModel | ✅ Supported | docs | |
CreateAuthorizer | ✅ Supported | JWT and REQUEST types; config stored | docs |
GetAuthorizer | ✅ Supported | docs | |
GetAuthorizers | ✅ Supported | docs | |
DeleteAuthorizer | ✅ Supported | docs | |
CreateRequestValidator | ✅ Supported | validateRequestBody, validateRequestParams | docs |
GetRequestValidators | ✅ Supported | docs | |
DeleteRequestValidator | ✅ Supported | docs | |
CreateApiKey | ✅ Supported | auto-generated key value | docs |
GetApiKey | ✅ Supported | docs | |
GetApiKeys | ✅ Supported | docs | |
DeleteApiKey | ✅ Supported | docs | |
CreateUsagePlan | ✅ Supported | throttle (token bucket) and quota measured per API key; rejection needs OVERCAST_ENFORCE_APIGATEWAY_THROTTLE | docs |
GetUsagePlan | ✅ Supported | docs | |
GetUsagePlans | ✅ Supported | docs | |
DeleteUsagePlan | ✅ Supported | docs | |
CreateUsagePlanKey | ✅ Supported | docs | |
GetUsagePlanKeys | ✅ Supported | docs | |
DeleteUsagePlanKey | ✅ Supported | docs | |
GetUsage | ✅ Supported | daily [used, remaining] log per API key; counts are in-memory and reset on restart | docs |
CreateDomainName | ✅ Supported | Inert metadata; no routing effect | docs |
GetDomainNames | ✅ Supported | docs | |
DeleteDomainName | ✅ Supported | docs | |
CreateBasePathMapping | ✅ Supported | Stored under the domain name | docs |
GetBasePathMappings | ✅ Supported | docs | |
CreateVpcLink | ✅ Supported | Status immediately AVAILABLE; no VPC connectivity enforced | docs |
GetVpcLinks | ✅ Supported | docs | |
DeleteVpcLink | ✅ Supported | docs | |
TagResource | ✅ Supported | PUT /tags/{arn} — merges tags; ARN may contain slashes | docs |
UntagResource | ✅ Supported | DELETE /tags/{arn}?tagKeys=k1,k2 | docs |
GetTags | ✅ Supported | docs | |
GetAccount | ❌ Unsupported | docs | |
UpdateAccount | ❌ Unsupported | docs |
HTTP API v2 management
| Operation | Status | Notes | AWS Docs |
|---|---|---|---|
CreateV2Api | ✅ Supported | HTTP and WEBSOCKET protocol types; default route selection | docs |
GetV2Api | ✅ Supported | docs | |
GetV2Apis | ✅ Supported | Pagination not yet implemented | docs |
UpdateV2Api | ✅ Supported | docs | |
DeleteV2Api | ✅ Supported | Cascade deletes routes, integrations, stages, deployments | docs |
CreateV2Route | ✅ Supported | docs | |
GetV2Route | ✅ Supported | docs | |
GetV2Routes | ✅ Supported | docs | |
DeleteV2Route | ✅ Supported | docs | |
UpdateV2Route | ✅ Supported | Patch routeKey, target, authorizationType | docs |
CreateIntegration | ✅ Supported | AWS_PROXY / HTTP_PROXY types; payloadFormatVersion 1.0/2.0 | docs |
GetV2Integration | ✅ Supported | docs | |
GetV2Integrations | ✅ Supported | docs | |
DeleteIntegration | ✅ Supported | docs | |
UpdateIntegration | ✅ Supported | Patch integrationType, integrationUri, payloadFormatVersion | docs |
HTTP API v2 stages
| Operation | Status | Notes | AWS Docs |
|---|---|---|---|
CreateV2Deployment | ✅ Supported | docs | |
GetV2Deployments | ✅ Supported | docs | |
CreateV2Stage | ✅ Supported | docs | |
GetV2Stage | ✅ Supported | docs | |
GetV2Stages | ✅ Supported | docs | |
DeleteV2Stage | ✅ Supported | docs |
HTTP API v2 other
| Operation | Status | Notes | AWS Docs |
|---|---|---|---|
UpdateV2Stage | ✅ Supported | Patch description, autoDeploy, deploymentId, stageVariables | docs |
CreateV2Authorizer | ✅ Supported | JWT and REQUEST types; config stored | docs |
GetV2Authorizer | ✅ Supported | docs | |
GetV2Authorizers | ✅ Supported | docs | |
DeleteV2Authorizer | ✅ Supported | docs | |
CreateV2DomainName | ✅ Supported | Inert metadata; no routing effect | docs |
GetV2DomainNames | ✅ Supported | docs | |
DeleteV2DomainName | ✅ Supported | docs | |
CreateV2VpcLink | ✅ Supported | Status immediately AVAILABLE; no VPC connectivity enforced | docs |
GetV2VpcLinks | ✅ Supported | docs | |
DeleteV2VpcLink | ✅ Supported | docs | |
CreateV2ApiMapping | ✅ Supported | Stored under the domain name | docs |
GetV2ApiMappings | ✅ Supported | docs | |
TagV2Resource | ✅ Supported | POST /v2/tags/{arn} — merges tags; ARN may contain slashes | docs |
UntagV2Resource | ✅ Supported | DELETE /v2/tags/{arn}?tagKeys=k1,k2 | docs |
GetV2Tags | ✅ Supported | docs | |
ExecuteV2API | ✅ Supported | AWS_PROXY and HTTP_PROXY integration types; records the same Count/4xx/5xx/Latency/IntegrationLatency metrics (HTTP APIs use AWS’s lowercase 4xx/5xx metric names, not REST’s 4XXError/5XXError) under all three AWS-documented HTTP dimension combinations — ApiId, ApiId+Stage, and ApiId+Stage+HttpMethod+RouteKey | docs |
REST API v1 execution
| Operation | Status | Notes | AWS Docs |
|---|---|---|---|
ExecuteRestAPI | ✅ Supported | Lambda proxy/non-proxy, HTTP_PROXY, HTTP, and MOCK integrations; stage variable substitution; base64 Lambda responses decoded before write; records AWS/ApiGateway CloudWatch metrics Count, 4XXError, 5XXError, Latency, and IntegrationLatency once per dispatched request under all three AWS-documented REST dimension combinations — ApiName, ApiName+Stage, and ApiName+Stage+Method+Resource (#1307) — an unresolvable restApiId records nothing, since there is no ApiName to dimension a series with | docs |
Related
- API Gateway — quick start, what works, and the differences from AWS
- All service pages