Reference
Set Headers Policy
Adds or sets headers on the on the outgoing response.
Configuration
The configuration shows how to configure the policy in the 'policies.json' document.
Policy Configuration
name
<string> - The name of your policy instance. This is used as a reference in your routes.policyType
<string> - The identifier of the policy. This is used by the Zuplo UI. Value should beset-headers-outbound
.handler.export
<string> - The name of the exported type. Value should beSetHeadersOutboundPolicy
.handler.module
<string> - The module containing the policy. Value should be$import(@zuplo/runtime)
.handler.options
<object> - The options for this policy. See Policy Options below.
Policy Options
The options for this policy are specified below. All properties are optional unless specifically marked as required.
headers
<object[]> (Required) -An array of headers to set on the response. By default, headers will be overwritten if they already exists in the response, specify the overwrite property to change this behavior.name
<string> (Required) -The name of the header.value
<string> (Required) -The value of the header.overwrite
<boolean> -Overwrite the value if the header is already present in the response.Defaults totrue
.
Using the Policy
Read more about how policies work