MENU
      Add gateway response status code

        Add gateway response status code


        Article summary

        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:

        MethodURI
        POST/products/{product-id}/apis/{api-id}/responses/{response-type}

        Request headers

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

        Request path parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        product-idStringRequiredProduct ID that the API belongs to
        api-idStringRequiredID of the API whose response status code you want to change
        response-typeStringRequiredGateway response type

        Request syntax

        The request syntax is as follows.

        {
          "statusCode" : 0
        }
        JSON

        Request body

        The following describes the request body.

        FieldTypeRequiredDescription
        statusCodeIntegerRequiredResponse status code to change

        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
        }'
        Curl

        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
        }
        JSON

        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
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.