Add gateway response header
- Print
- PDF
Add gateway response header
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Add a custom header to the gateway response you have.
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}/headers |
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 response header you want to add
|
response-type | String | Required | Gateway response type
|
Request syntax
The request syntax is as follows.
{
"headerName" : "headerName",
"headerValue" : "headerValue"
}
Request body
The following describes the request body.
| Field | Type | Required | Description |
|---|---|---|---|
headerName | String | Required | Name of the header to add |
headerValue | String | Required | Header value |
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/headers' \
--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 '{
"headerName" : "codeType",
"headerValue" : "normal"
}'
Response
The following describes the response format.
Response syntax
The response syntax is as follows.
{
"apiId" : "apiId",
"responseType" : "responseType",
"headerName" : "headerName",
"headerValue" : "headerValue"
}
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",
"headerName": "codeType",
"headerValue": "normal"
}
Was this article helpful?