Cache settings

A cache setting is an object on an application that tells Cache how to store and serve a response. It holds the browser TTL, the cache TTL and behavior, stale cache, Large File Optimization, Tiered Cache, and the cache variation rules. A Rules Engine rule with the Set Cache Policy behavior applies the setting to the requests it matches. Until a rule names it, a setting does nothing. To create one, refer to Create a cache setting.

Interfaces

Six interfaces write the same object. The tables on this page name the Console control, the API field, and the CLI flag of each field.

The API authenticates with a personal token in the Authorization: Token <token> header. For more information, refer to Personal tokens. An AzionCache entry carries name, stale, queryStringSort, tieredCache, methods, browser.maxAgeSeconds, edge.maxAgeSeconds, cacheByCookie, and cacheByQueryString.

General

The General section of the drawer holds the name. The API requires name and nothing else.

Browser Cache

The Browser Cache section decides what the browser is told to keep, through the browser_cache object.

Honor cache policies keeps the Cache-Control and Expires headers the origin sends and forwards them to the browser. Override cache settings replaces them with the TTL in browser_cache.max_age. For No cache, the Console reads: “Disable browser caching to ensure content is always fetched directly from the server”. On azion update cache-setting, the flag for browser_cache.behavior is --browser-cache-settings.

Cache

The Cache section sets how long Azion keeps the copy and what it does with it, through the modules.cache object.

Honor cache policies keeps the Cache-Control and Expires headers the origin sends; Override cache behavior replaces them with Max Age. Stale cache lets Azion serve an expired copy when the origin fails. Large file optimization stores a large object in fragments of 1,024 kB. Tiered Cache adds a second cache layer between Azion’s cache and the origin. For how each one behaves on a request, refer to Expiration and freshness.

Application Accelerator

The four Cache vary by controls of the Application Accelerator section write the modules.application_accelerator object. Every field in it requires the Application Accelerator module on the application, or the API returns error 21013. The query-string and cookie fields configure Advanced Cache Key; the device fields use the groups defined in Device Groups. For what each behavior does to the cache key, refer to Application Accelerator settings.

Ignore varies the key by none of the values, and All by every value that arrives. Allowlist varies it by the named values, and Denylist by every value except the named ones. Allowlist and Denylist on the query string need at least one field, or the API returns error 21018. For the Console steps that set these controls, refer to Configure Advanced Cache Key for an application.

Request body

The request body below creates a complete cache setting through POST /v4/workspace/applications/{application_id}/cache_settings:

The API answers with HTTP 201, state set to executed, and the new object with its id under data:

The list endpoint wraps the settings of an application in a page envelope:

The CLI writes the fields its flags cover from the command line:

The command prints the id of the new setting:

The flags cover browser cache, query-string and cookie variation, and OPTIONS caching. Every other field, including Max Age, the cache behavior, stale cache, Large File Optimization, and Tiered Cache, is set through --file with the JSON body.

Errors

The API answers each request below with HTTP 400. The body carries the code and the title, and a field error also points at the field.

Limits

The bounds below apply to one cache setting. Each row names the API’s answer past the value.

For purge limits and the amounts each plan includes, refer to Applications limits.

Related resources