HTTP Response Header Management Plug-in¶
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 the HTTP response header management plug-in, contact customer service to upgrade the gateway.
Usage Guidelines¶
You cannot modify the response headers, such as x-apig-* and x-request-id, added by APIG, or the headers configured 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 the specified header. Override
Append
Delete
Skip
Add The value of the specified header will be returned even if the header does not exist in an API response. |
Example Script¶
{
"response_headers": [
{
"name": "test",
"value": "test",
"action": "append"
},
{
"name": "test1",
"value": "test1",
"action": "override"
}
]
}