Skip to main content

Cache rules

A cache rule controls how the edge caches the responses for URLs that match its URL operator. It sets a TTL and, optionally, a set of per-URL location features that override your property-level defaults for the matching requests.

Fields

FieldTypeRequiredNotes
namestringYesDisplay name. Max length 200.
patternstringYesThe match value. Max length 500. See match operators.
matchTypeintegerYesEquals=0, Contains=1, StartsWith=2, EndsWith=3, Regex=4.
ttlSecondsintegerYesCache lifetime in seconds. Default 300 (5 minutes), minimum 0.
orderintegerYesLower runs first. See how rules work.
isEnabledbooleanYesToggle without deleting.
descriptionstringNoOptional free-text note.
featuresJsonstring (JSON)NoPer-rule location features. Max length 5000. See Location features.
A TTL of 0 means do not cache

ttlSeconds: 0 effectively bypasses the cache for matching requests — nothing is stored. Use it to force matching URLs (for example, a cart or checkout path) to always go to the origin.

Example

Cache everything under /static/ for one hour. In the property's Rules tab, click Add cache rule and set:

  • Pattern: /static/Starts with
  • TTL: 3600 (1 hour)

Then expand Location Features (Optional) to fine-tune just these URLs (see below).

Location features

Location features override your property-level defaults for the URLs this rule matches. In the panel they live under a collapsible Location Features (Optional) panel — set only what you want to override.

OptionShapePurpose
bypass_cookiesarray of cookie namesIf any listed cookie is present on the request, the cache is bypassed (for example, a logged-in session cookie).
cache_keyobjectCustomizes what goes into the cache key.
cache_key.include_query_stringbooleanInclude the query string in the cache key.
cache_key.include_headersarray of header namesAdd these request headers to the cache key (for example, Accept-Language).
cache_key.include_cookiesarray of cookie namesAdd these cookies to the cache key.
minificationobjectMinify matching responses.
minification.html | css | jsbooleanEnable minification per content type.
webpobjectAuto-convert images to WebP.
webp.enabledbooleanTurn WebP conversion on.
webp.qualityintegerWebP quality, 1–100, default 80.
webp.only_if_smallerbooleanOnly serve WebP when it is smaller than the original.
Bypass the cache for logged-in users

Listing your CMS session cookie (such as wordpress_logged_in) under bypass_cookies keeps anonymous visitors on the fast cached path while logged-in users always see fresh, personalized pages. See the WordPress examples for a full setup.

Next steps