cache_id

Property Manager name: Cache ID Modification
Behavior version: The v2025-01-13 rule format supports the cache_id behavior v1.3.
Rule format status: GA, stable
Access: Read/Write
Allowed in includes: Yes

Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier.

Note that this behavior executes differently than usual within rule trees. Applying a set of cacheId behaviors within the same rule results in a system of forming cache keys that applies independently to the rule's content. If any cacheId behaviors are present in a rule, any others specified in parent rules or prior executing sibling rules no longer apply. Otherwise for any rule that lacks a cacheId behavior, the set of behaviors specified in an ancestor or prior sibling rule determines how to form cache keys for that content.

Option	Type	Description	Requires
`rule`	enum	Specifies how to modify the cache ID.		{"displayType":"enum","options":["INCLUDE_QUERY_PARAMS","INCLUDE_COOKIES","INCLUDE_HEADERS","EXCLUDE_QUERY_PARAMS","INCLUDE_ALL_QUERY_PARAMS","INCLUDE_VARIABLE","INCLUDE_URL"],"tag":"select"}
	`INCLUDE_QUERY_PARAMS`	Includes the specified set of query parameters when forming a cache ID.
	`INCLUDE_COOKIES`	Includes specified cookies in the cache ID.
	`INCLUDE_HEADERS`	Includes specified HTTP headers in the cache ID.
	`EXCLUDE_QUERY_PARAMS`	Excludes the specified set of query parameters when forming a cache ID.
	`INCLUDE_ALL_QUERY_PARAMS`	Includes all query parameters when forming a cache ID.
	`INCLUDE_VARIABLE`	Includes a specific user variable in the cache ID.
	`INCLUDE_URL`	Includes the full URL, the same as the default without the `cacheid` behavior.
`include_value`	boolean	Includes the value of the specified elements in the cache ID. Otherwise only their names are included.	`rule` is either: `INCLUDE_COOKIES`, `INCLUDE_QUERY_PARAMS`, `INCLUDE_HEADERS`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"rule","op":"in","value":["INCLUDE_COOKIES","INCLUDE_QUERY_PARAMS","INCLUDE_HEADERS"]}}
`optional`	boolean	Requires the behavior's specified elements to be present for content to cache. When disabled, requests that lack the specified elements are still cached.	`rule` is either: `INCLUDE_COOKIES`, `INCLUDE_QUERY_PARAMS`, `INCLUDE_HEADERS`, `EXCLUDE_QUERY_PARAMS`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"rule","op":"in","value":["INCLUDE_COOKIES","INCLUDE_QUERY_PARAMS","INCLUDE_HEADERS","EXCLUDE_QUERY_PARAMS"]}}
`elements`	string array	Specifies the names of the query parameters, cookies, or headers to include or exclude from the cache ID.	`rule` is either: `INCLUDE_COOKIES`, `INCLUDE_QUERY_PARAMS`, `INCLUDE_HEADERS`, `EXCLUDE_QUERY_PARAMS`	{"displayType":"string array","tag":"input","todo":true} {"if":{"attribute":"rule","op":"in","value":["INCLUDE_COOKIES","INCLUDE_QUERY_PARAMS","INCLUDE_HEADERS","EXCLUDE_QUERY_PARAMS"]}}
`variable_name`	string (variable name)	Specifies the name of the variable you want to include in the cache key.	`rule` is `INCLUDE_VARIABLE`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"rule","op":"eq","value":"INCLUDE_VARIABLE"}}

Updated 38 minutes ago