---
title: "ゲートウェイレスポンステンプレートの追加"
slug: "apigateway-posttemplates"
updated: 2026-09-17T09:57:24Z
published: 2026-09-17T09:57:24Z
canonical: "api.ncloud-docs.com/apigateway-posttemplates"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ゲートウェイレスポンステンプレートの追加

Classic/VPC環境で利用できます。

ゲートウェイレスポンス本文として返されるマッピングテンプレートを定義して追加します。

## リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

| メソッド | URI |
| --- | --- |
| POST | /api/v1/products/{product-id}/apis/{api-id}/responses/{response-type}/templates |

### リクエストヘッダ

API Gatewayで共通して使用されるヘッダの詳細は、[API Gatewayのリクエストヘッダ](/docs/ja/ai-application-service-apigateway#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

### リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `product-id` | String | Required | APIが属する Product ID - 1~10文字 - [Productリストの照会](/docs/ja/apigateway-product-getproductlist)を参照 |
| `api-id` | String | Required | マッピングテンプレートを追加する対象の API ID - 1~10文字 - [APIの照会](/docs/ja/apigateway-api-apis)を参照 |
| `response-type` | String | Required | ゲートウェイレスポンスのタイプ - 1~45文字 - [ゲートウェイレスポンスの照会](/docs/ja/apigateway-getresponses)を参照 |

### リクエスト構文

リクエスト構文は次の通りです。

```
{
  "mappingTemplate" : "mappingTemplate",
  "contentType" : "contentType"
}
```

### リクエストボディ

リクエストボディの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `mappingTemplate` | String | Required | 追加するテンプレートの内容 - 1~500文字 |
| `contentType` | String | Required | コンテンツタイプ - HTTPの Content-Typeヘッダに対応する値 - 1~100文字 - <例> `application/json`、`application/xml`、`text/plain` |

### リクエスト例

リクエストのサンプルコードは次の通りです。

```
curl --location --request POST '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\": \"authentication error\" }",
  "contentType" : "application/json"
}'
```

## レスポンス

レスポンス形式を説明します。

### レスポンス構文

レスポンス構文は次の通りです。

```
{
  "apiId" : "apiId",
  "responseType" : "responseType",
  "contentType" : "contentType",
  "mappingTemplate" : "mappingTemplate" 
}
```

### レスポンスステータスコード

API Gateway APIで共通して使用されるレスポンスステータスコードの詳細は、[API Gatewayのレスポンスステータスコード](/docs/ja/ai-application-service-apigateway#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

レスポンスのサンプルコードは次の通りです。

```
{
    "apiId": "cvcohvd2xj",
    "responseType": "AUTHENTICATION_FAILED",
    "contentType": "application/json",
    "mappingTemplate": "{ \"error\": \"authentication error\" }"
}
```