Clear Response Headers Policy

Removes all headers from the response except for those in the exclude list.


The configuration shows how to configure the policy in the 'policies.json' document.

{ "name": "my-clear-headers-outbound-policy", "policyType": "clear-headers-outbound", "handler": { "export": "ClearHeadersOutboundPolicy", "module": "$import(@zuplo/runtime)", "options": { "exclude": [ "my-header", "aws-request-id" ] } } }

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 be clear-headers-outbound.
  • handler.export <string> - The name of the exported type. Value should be ClearHeadersOutboundPolicy.
  • 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.

  • exclude <string[]> -
    The headers that should not be removed.

Using the Policy

Read more about how policies work

Remove Response Headers