MENU
      Edit gateway response template

        Edit gateway response template


        Article summary

        Available in Classic and VPC

        Edit the content of the template that will be mapped to the body of the gateway response.

        Request

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

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

        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 mapped template you want to edit
        response-typeStringRequiredGateway response type

        Request syntax

        The request syntax is as follows.

        {
          "mappingTemplate" : "mappingTemplate",
          "contentType" : "contentType"
        }
        JSON

        Request body

        The following describes the request body.

        FieldTypeRequiredDescription
        mappingTemplateStringRequiredContent of the template to edit to
        contentTypeStringRequiredContent type
        • Equivalent to the Content-Type header in HTTP
        • 1 - 100 characters
        • <E.g.> application/json, application/xml, text/plain

        Request example

        The following is a sample request.

        curl --location --request PATCH 'https://apigateway.apigw.ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/responses/AUTHENTICATION_FAILED/templates' \
        --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 '{
          "mappingTemplate" : "{ \"error\" : \"${context.apiName}\" }",
          "contentType" : "application/json"
        }'
        Curl

        Response

        The following describes the response format.

        Response status codes

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


        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.