Last update: 2023-11-03
  • Created for:
  • Developer

Client cache time to live. Number of hours until expiration. Used to manage client and proxy server caching.

The server calculates the expiration time/date of the NTTP response data by adding this value to the time/date of transmission.

Browsers manage caches using expiration times of files. Before passing a request to the server, the browser checks its cache to see if the file has already been down-loaded. If so, and if the file has not yet expired, the browser sends a conditional GET request (for example with the If-Modified-Since HTTP request header) rather than a normal GET request. The server has the option of responding with a ‘304’ status and not transmitting the image. The browser then simply loads the file from its cache. This may substantially increase overall performance for frequently accessed data.

The server sets the expires HTTP response header to the current date/time plus the smallest of vignette::Expiration and all catalog::Expiration values for the vignette and all materials involved in the render operation.

The expiration is set primarily for image data responses. Certain types of responses are always marked for immediate expiration (or tagged as non-cacheable), including all error responses or property replies.


Real number, -2, -1, 0, or greater. Number of hours until expiration since the response image was generated. Set to 0 to always expire the response image immediately, which effectively disables client caching. Set to -1 to mark as never expire. In this case the server always returns 304 status (not-modified) in response to conditional GET requests without checking whether the file has actually changed. Set to -2 to use the default provided by attribute::Expiration.


attribute::Expiration is used if the field is not present, if the value is -2, or if the field is empty.

See also

attribute::Expiration , vignette::Expiration, req=

On this page