metadataStage

  • Property Manager name: Metadata Stage
  • Criteria version: The v2024-02-12 rule format supports the metadataStage criteria v1.0.
  • Rule format status: GA, stable
  • Access: Read-write
  • Allowed in includes: Yes

Matches how the current rule corresponds to low-level syntax elements in translated XML metadata, indicating progressive stages as each edge server handles the request and response. To use this match, you need to be thoroughly familiar with how Akamai edge servers process requests. Contact your Akamai Technical representative if you need help, and test thoroughly on staging before activating on production.

OptionTypeDescriptionRequires
match​Operatorenum

Compares the current rule with the specified metadata stage.

{"displayType":"enum","options":["IS","IS_NOT"],"tag":"select"}
IS

The current rule is at the specified metadata stage.

IS_​NOT

The current rule is not at the specified metadata stage.

valueenum

Specifies the metadata stage.

{"displayType":"enum","options":["cache-hit","client-done","client-request","client-request-body","client-response","content-policy","forward-request","forward-response","forward-start","ipa-response"],"tag":"select"}
cache-hit

Content is cacheable and is already cached, but not yet tested for freshness.

client-done

Occurs after the response completes and the response has been sent to the requesting client Only used for receipt requests and products like Cloud Monitor and Datastream.

client-request

When the Akamai server receives the request. Most processing happens in this stage, including determining the object's cacheability and cache key.

client-request-body

Runs when the Akamai server inspects the contents of a request POST body, typically as a security check.

client-response

Occurs after the full response has been returned from the forward server or retrieved from Akamai's cache, prior to constructing a response.

content-policy

This stage determines whether any Cloudlets or security products are associated with the request. It gets ignored in requests for other products.

forward-request

Immediately before the Akamai server tries to connect to a forward server (either an Akamai parent server or a customer origin). Doesn't run for the content retrieved from Akamai's cache.

forward-response

After the forward server responds and all response headers have been read. Doesn't run for the content retrieved from Akamai's cache.

forward-start

Immediately before the forward-request stage, while the Akamai server selects a forward server or persistent connection. Doesn't run for the content retrieved from Akamai's cache.

ipa-response

Runs when a response is received from an intermediate processing agent (IPA) server, called at the end of the client-request stage.