PUT

/restapis/{restapi_id}/gatewayresponses/{response_type}

http://apigateway.{region}.amazonaws.com/restapis/{restapi_id}/gatewayresponses/{response_type}

Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

Access Token Required: API Key

Path Parameters

restapi_idstringrequired

The string identifier of the associated RestApi.

response_typestringrequired

The response type of the associated GatewayResponse

Allowed:

Body Params

statusCodestring

The status code.

responseTemplatesobject

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

responseParametersobject

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

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 PUT \
2     --url 'http://apigateway.{region}.amazonaws.com/restapis/{restapi_id}/gatewayresponses/{response_type}' \
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}