/v2/apis/{apiId}/routes

POST

Creates a Route for an API.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v2/apis//routes' \
--header 'Content-Type: application/json' \
--data-raw ''

Response Example

201 - Example 1

{
  "ApiGatewayManaged": true,
  "ApiKeyRequired": true,
  "AuthorizationScopes": {},
  "AuthorizationType": "NONE",
  "AuthorizerId": "string",
  "ModelSelectionExpression": "string",
  "OperationName": "string",
  "RequestModels": {
    "property1": "string",
    "property2": "string"
  },
  "RequestParameters": {
    "property1": {
      "Required": true
    }
  },
  "RouteId": "string",
  "RouteKey": "string",
  "RouteResponseSelectionExpression": "string",
  "Target": "string"
}

Request

Path Params

apiId

string

required

The API identifier.

Body Params application/json

apiKeyRequired

boolean

optional

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

authorizationScopes

array[string]

optional

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

enum<string>

optional

The authorization type. 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.

Allowed values:

NONEAWS_IAMCUSTOMJWT

authorizerId

string

optional

The identifier.

modelSelectionExpression

string

optional

An expression used to extract information at runtime. See Selection Expressions for more information.

operationName

string

optional

A string with a length between [1-64].

requestModels

object

optional

The route models.

Additional properties

string

optional

A string with a length between [1-128].

requestParameters

object

optional

The route parameters.

Additional properties

object (ParameterConstraints)

optional

Validation constraints imposed on parameters of a request (path, query string, headers).

routeKey

string

required

After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.

routeResponseSelectionExpression

string

optional

An expression used to extract information at runtime. See Selection Expressions for more information.

target

string

optional

A string with a length between [1-128].

Examples

Responses

🟢201Success

application/json

Body

ApiGatewayManaged

boolean

optional

Specifies whether a route is managed by API Gateway. If you created an API using quick create, the

d e f a u lt ro u t e i s mana g e d b y A P I G a t e w a y . Y o u c a n^{'} t m o d i f y t h e

default route key.

ApiKeyRequired

boolean

optional

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

AuthorizationScopes

object

optional

AuthorizationType

enum<string>

optional

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.

Allowed values:

NONEAWS_IAMCUSTOMJWT

AuthorizerId

string

optional

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.

ModelSelectionExpression

string

optional

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

OperationName

string

optional

The operation name for the route.

RequestModels

object

optional

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

RequestParameters

object

optional

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

RouteId

string

optional

The route ID.

RouteKey

string

optional

The route key for the route.

RouteResponseSelectionExpression

string

optional

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

Target

string

optional

The target for the route.

🟠480NotFoundException

🟠481TooManyRequestsException

🟠482BadRequestException

🟠483ConflictException

Modified at 2023-08-15 05:49:07

/v2/apis/{apiId}/models

/v2/apis/{apiId}/routes