Fastly · Schema

Header

A header object manipulates HTTP headers during request and response processing at the edge.

CDNEdge CloudEdge ComputeWebAssemblySecurityAIObservabilityAsyncAPIStreamingWebhooksLogging

Properties

Name	Type	Description
name	string	The name of the header rule.
action	string	The action to take on the header.
type	string	The type of header manipulation.
dst	string	The name of the header to modify.
src	string	A variable expression used to derive the value.
regex	string	A regular expression used for regex-based actions.
substitution	string	The substitution string for regex-based actions.
priority	integer	The priority of the header rule.
ignore_if_set	boolean	Whether to skip the header rule if the header is already set.
request_condition	string	The name of the condition that triggers the header rule.
response_condition	string	The name of the condition that triggers the header rule on responses.
cache_condition	string	The name of the condition that triggers the header rule on cache.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Header",
  "title": "Header",
  "type": "object",
  "description": "A header object manipulates HTTP headers during request and response processing at the edge.",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the header rule."
    },
    "action": {
      "type": "string",
      "description": "The action to take on the header.",
      "enum": [
        "set",
        "append",
        "delete",
        "regex",
        "regex_repeat"
      ]
    },
    "type": {
      "type": "string",
      "description": "The type of header manipulation.",
      "enum": [
        "request",
        "fetch",
        "cache",
        "response"
      ]
    },
    "dst": {
      "type": "string",
      "description": "The name of the header to modify."
    },
    "src": {
      "type": "string",
      "description": "A variable expression used to derive the value."
    },
    "regex": {
      "type": "string",
      "description": "A regular expression used for regex-based actions."
    },
    "substitution": {
      "type": "string",
      "description": "The substitution string for regex-based actions."
    },
    "priority": {
      "type": "integer",
      "description": "The priority of the header rule.",
      "default": 100
    },
    "ignore_if_set": {
      "type": "boolean",
      "description": "Whether to skip the header rule if the header is already set."
    },
    "request_condition": {
      "type": "string",
      "description": "The name of the condition that triggers the header rule."
    },
    "response_condition": {
      "type": "string",
      "description": "The name of the condition that triggers the header rule on responses."
    },
    "cache_condition": {
      "type": "string",
      "description": "The name of the condition that triggers the header rule on cache."
    }
  }
}