GuideReference
TrainingSupportCommunity

return_​cache_​status

  • Property Manager name: Return Cache Status
  • Behavior version: The v2023-09-20 rule format supports the return_​cache_​status behavior v1.0.
  • Rule format status: GA, stable
  • Access: Read-write
  • Allowed in includes: Yes

Generates a response header with information about cache status. Among other things, this can tell you whether the response came from the Akamai cache, or from the origin. Status values report with either of these forms of syntax, depending for example on whether you're deploying traffic using sure​_route or tiered​_distribution:

{status} from child
{status} from child, {status} from parent

The status value can be any of the following:

  • Hit - the object was retrieved from Akamai's cache.
  • Miss - the object was not found in the Akamai cache.
  • Refresh​Hit - the object was found in Akamai's cache, but was stale, so an If-Modified-Since request was made to the customer origin, with 304 as the response code, indicating unmodified content.
  • Hit​Stale - the object was found in Akamai's cache and was stale, but a more recent object was not available from the customer origin, so the cache served the stale object to the client.
  • Constructed - the construct​_response behavior directly specified the response to the client.
  • Redirect - the Akamai edge configuration specified a redirect, typically by executing the redirect, redirectplus, or edge​_redirector behaviors.
  • Error - an error occurred, typically when authorization is denied or the request is rejected by WAF.
OptionTypeDescriptionRequires
response_​header_​namestring

Specifies the name of the HTTP header in which to report the cache status value.

{"displayType":"string","tag":"input","type":"text"}