Amazon API Gateway REST API Reference

gatewayresponse:delete

Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.

HTTP Request

DELETE /restapis/<restapi_id>/gatewayresponses/<response_type>

Remarks

For more information about valid gateway response types, see Gateway Response Types Supported by Amazon API Gateway

Example: Clear the customization of a Gateway Response of a given response type

Request

This example shows how to clear any customization of a gateway response of the MISSING_AUTHENTICATION_TOKEN type.

DELETE /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1
Host: beta-apigateway.us-east-1.amazonaws.com
Content-Type: application/json
X-Amz-Date: 20170503T205948Z
Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature=0857cfa0bf6c45ab99f27f14b830fe26fd285dd578d9caed60607936772716f2
Cache-Control: no-cache
Postman-Token: f463e766-ccb5-e31a-d83e-ad9a9692db7c

Response

The successful operation returns the 201 Accepted status code without payload.

This DELETE operation resets the gateway response to its default settings.

See Also

Customize Gateway Responses