Add gateway response status code

Available in Classic and VPC

Change a defined response status code for the gateway.

Request

The following describes the request format for the endpoint. The request format is as follows:

Request headers

For headers common to API Gateway, see API Gateway common request headers.

Request path parameters

The following describes the parameters.

Request syntax

The request syntax is as follows.

{
  "statusCode" : 0
}

Request body

The following describes the request body.

Request example

The following is a sample request.

curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/responses/AUTHENTICATION_FAILED' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
  "statusCode" : 401
}'

Response

The following describes the response format.

Response syntax

The response syntax is as follows.

{
    "apiId": "apiId",
    "responseType": "responseType",
    "responseName": "responseName",
    "statusCode": 000,
    "default": false
}

Response status codes

For response status codes common to all API Gateway APIs, see API Gateway response status codes.

Response example

The following is a sample response.

{
    "apiId": "cvcohvd2xj",
    "responseType": "AUTHENTICATION_FAILED",
    "responseName": "Authentication Failed",
    "statusCode": 401,
    "default": false
}