Edit gateway response template
- Print
- PDF
Edit gateway response template
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
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:
| Method | URI |
|---|---|
| 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.
| Field | Type | Required | Description |
|---|---|---|---|
product-id | String | Required | Product ID that the API belongs to
|
api-id | String | Required | ID of the API whose mapped template you want to edit
|
response-type | String | Required | Gateway response type
|
Request syntax
The request syntax is as follows.
{
"mappingTemplate" : "mappingTemplate",
"contentType" : "contentType"
}
Request body
The following describes the request body.
| Field | Type | Required | Description |
|---|---|---|---|
mappingTemplate | String | Required | Content of the template to edit to |
contentType | String | Required | Content type
|
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"
}'
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?