edge_side_includes

Suggest Edits

Version: `v2025-01-13`	Includes use: Yes

Behavior name: ESI (Edge Side Includes)

Allows edge servers to process edge side include (ESI) code to generate dynamic content. To apply this behavior, you need to match on a content_type, path, or filename. Since this behavior requires more parsing time, you should not apply it to pages that lack ESI code, or to any non-HTML content.

Default behavior

These samples reflect the behavior's default settings. You can use these as is in your configurations or make adjustments based on the behavior's available options.

data "akamai_property_rules_builder" "edge_side_includes" {
  rules_v2025_02_18 {
    name     = "ESI (Edge Side Includes)"
    comments = "Allows edge servers to process ESI code to generate dynamic content."
    behavior {
      edge_side_includes {
        enabled          = true
        enable_via_http  = false
        pass_set_cookie  = false
        pass_client_ip   = false
        i18n_status      = false
        detect_injection = false
      }
    }
  }
}

"behaviors": [
  {
  "name": "edgeSideIncludes",
  "options": {
    "enabled": true,
    "enableViaHttp": false,
    "passSetCookie": false,
    "passClientIp": false,
    "i18nStatus": false,
    "detectInjection": false
    }
  }
]

Options

Option	Description
`enabled`	Boolean Enables ESI processing.
`enable_via_http`	Boolean Enable ESI only for content featuring the `Edge-control: dca=esi` HTTP response header.
`pass_set_cookie`	Boolean \| Requires: `enable_via_http` is `true` Allows edge servers to pass your origin server's cookies to the ESI processor.
`pass_client_ip`	Boolean \| Requires: `enable_via_http` is `true` Allows edge servers to pass the client IP header to the ESI processor.
`i18n_status`	Boolean \| Requires: `enable_via_http` is `true` Provides internationalization support for ESI.
`i18n_charset`	String array \| Requires: `i18n_status` is `false` Specifies the character sets to use when transcoding the ESI language, `UTF-8` and `ISO-8859-1` for example.
`detect_injection`	Boolean Denies attempts to inject ESI code.

Updated about 1 hour ago