cache_​tag_​visible

Version: v2025-01-13Includes use: Yes

Behavior name: Cache Tag Visibility

Cache tags are comma-separated string values you define within an Edge-Cache-Tag header. You can use them to flexibly fast purge tagged segments of your cached content. You can either define these headers at the origin server level, or use the modify_outgoing_response_header behavior to configure them at the edge.

Apply this behavior to confirm you're deploying the intended set of cache tags to your content.

For guidance on deploying cache tags, see Fast Purge.

Use the Fast Purge API to purge by cache tag programmatically.

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" "cache_tag_visible" {
  rules_v2025_02_18 {
    name     = "Cache Tag Visibility"
    comments = "Confirm you're deploying the intended set of cache tags to your content."
    behavior {
      cache_tag_visible {
        behavior = "NEVER"
      }
    }
  }
}
"behaviors": [
  {
    "name": "cacheTagVisible",
    "options": {
      "behavior": "NEVER"
    }
  }
]

Options

Option Description
behavior
Specifies when to include the Edge-Cache-Tag in responses. Value is one of:
  • NEVER. Strip out the Edge-Cache-Tag header, edge servers' default response.
  • PRAGMA_HEADER. Edge servers respond with the Edge-Cache-Tag header only when you pass in a Pragma: akamai-x-get-cache-tags header as part of the request.
  • ALWAYS. Include the Edge-Cache-Tag header in all responses.