cacheId


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 cache‚ÄčId behaviors within the same rule results in a system of forming cache keys that applies independently to the rule's content. If any cache‚ÄčId 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 cache‚ÄčId behavior, the set of behaviors specified in an ancestor or prior sibling rule determines how to form cache keys for that content.

OptionTypeDescriptionRequires
ruleenum

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‚ÄčValueboolean

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"]}}
optionalboolean

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"]}}
elementsstring 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‚ÄčNamestring (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"}}