Fastly · Schema

RequestSettings

Request settings modify inbound requests at the edge before they are processed or forwarded to origin servers.

CDNEdge CloudEdge ComputeWebAssemblySecurityAIObservabilityAsyncAPIStreamingWebhooksLogging

Properties

Name	Type	Description
name	string	The name of the request settings rule.
action	string	The action to take when request settings are applied.
force_miss	boolean	Whether to force a cache miss for matching requests.
force_ssl	boolean	Whether to force SSL for matching requests.
bypass_busy_wait	boolean	Whether to disable collapsed forwarding for matching requests.
max_stale_age	integer	The maximum stale age in seconds.
hash_keys	string	A list of items to use as the cache hash key.
xff	string	How to handle the X-Forwarded-For header.
timer_support	boolean	Whether to inject Fastly-specific timing headers.
geo_headers	boolean	Whether to add geographic headers based on client IP.
default_host	string	Sets the host header sent to the backend.
request_condition	string	The name of the condition that triggers these request settings.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RequestSettings",
  "title": "RequestSettings",
  "type": "object",
  "description": "Request settings modify inbound requests at the edge before they are processed or forwarded to origin servers.",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the request settings rule."
    },
    "action": {
      "type": "string",
      "description": "The action to take when request settings are applied.",
      "enum": [
        "lookup",
        "pass"
      ]
    },
    "force_miss": {
      "type": "boolean",
      "description": "Whether to force a cache miss for matching requests."
    },
    "force_ssl": {
      "type": "boolean",
      "description": "Whether to force SSL for matching requests."
    },
    "bypass_busy_wait": {
      "type": "boolean",
      "description": "Whether to disable collapsed forwarding for matching requests."
    },
    "max_stale_age": {
      "type": "integer",
      "description": "The maximum stale age in seconds."
    },
    "hash_keys": {
      "type": "string",
      "description": "A list of items to use as the cache hash key."
    },
    "xff": {
      "type": "string",
      "description": "How to handle the X-Forwarded-For header.",
      "enum": [
        "clear",
        "leave",
        "append",
        "append_all",
        "overwrite"
      ]
    },
    "timer_support": {
      "type": "boolean",
      "description": "Whether to inject Fastly-specific timing headers."
    },
    "geo_headers": {
      "type": "boolean",
      "description": "Whether to add geographic headers based on client IP."
    },
    "default_host": {
      "type": "string",
      "description": "Sets the host header sent to the backend."
    },
    "request_condition": {
      "type": "string",
      "description": "The name of the condition that triggers these request settings."
    }
  }
}