v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1472221377.0 KB

Gets a Route.

get/v2/apis/{apiId}/routes/{routeId}

Path parameters

apiIdstring required

The API identifier.

routeIdstring required

The route ID.

Response

Success

ApiGatewayManagedboolean

Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

ApiKeyRequiredboolean

Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

AuthorizationScopesStringWithLengthBetween1And64[]

A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

AuthorizationType'NONE' | 'AWS_IAM' | 'CUSTOM' | 'JWT'

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

AuthorizerIdstring

The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

ModelSelectionExpressionstring

The model selection expression for the route. Supported only for WebSocket APIs.

OperationNamestring

The operation name for the route.

RequestModelsobject

The request models for the route. Supported only for WebSocket APIs.

RequestParametersobject

The request parameters for the route. Supported only for WebSocket APIs.

RouteIdstring

The route ID.

RouteKeystring

The route key for the route.

RouteResponseSelectionExpressionstring

The route response selection expression for the route. Supported only for WebSocket APIs.

Targetstring

The target for the route.