Add gateway response template
- Print
- PDF
Add gateway response template
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Define and add a mapping template to be returned in the gateway response body.
Request
The following describes the request format for the endpoint. The request format is as follows:
Method | URI |
---|---|
POST | /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 add
|
response-type | String | Required | Gateway response type
|
Request syntax
The request syntax is as follows.
Request body
The following describes the request body.
Field | Type | Required | Description |
---|---|---|---|
mappingTemplate | String | Required | Content of the template to add
|
contentType | String | Required | Content type
|
Request example
The following is a sample request.
Response
The following describes the response format.
Response syntax
The response syntax is as follows.
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.
Was this article helpful?