HTTP Response Header Management¶
HTTP response headers are part of the response returned by APIG to a client that calls an API. You can customize HTTP response headers that will be contained in an API response.
Note
If your gateway does not support this policy, contact technical support to upgrade the gateway to the latest version.
Usage Guidelines¶
You have understood the guidelines for policy creation and API binding.
You cannot modify the response headers (including x-apig-* and x-request-id) added by APIG or the headers required for CORS.
Configuration Parameters¶
Parameter | Description |
|---|---|
Name | Response header name, which is case-insensitive and must be unique within a plug-in. You can add a maximum of 10 response headers. |
Value | Value of the response header. This parameter does not take effect and can be left blank if you set Action to Delete. |
Action | Response header operation. You can override, append, delete, skip, or add response headers. Override
Append
Delete
Skip
Add The value of this response header will be returned in an API response even if the response contains a response header with the same name. |
Example Script¶
{
"response_headers": [
{
"name": "test",
"value": "test",
"action": "append"
},
{
"name": "test1",
"value": "test1",
"action": "override"
}
]
}