GET

/restapis/{restapi_id}/gatewayresponses

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

Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.

Access Token Required: API Key

Path Parameters

restapi_idstringrequired

The string identifier of the associated RestApi.

Query Params

positionstring

The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.

limitinteger

The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here.

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