POST

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

http://apigateway.{region}.amazonaws.com/v2/apis/{apiId}/routes/{routeId}/routeresponses

Creates a RouteResponse for a Route.

Access Token Required: API Key

Path Parameters

apiIdstringrequired

The API identifier.

routeIdstringrequired

The route ID.

Body Params

responseModelsobject

The route models.

routeResponseKeystringrequired

After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions">Selection Expressions</a> for a list of expressions and each expression's associated selection key type.

responseParametersobject

The route parameters.

modelSelectionExpressionstring

An expression used to extract information at runtime. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions">Selection Expressions</a> for more information.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://apigateway.{region}.amazonaws.com/v2/apis/{apiId}/routes/{routeId}/routeresponses' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}