Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This policy executes after authentication and traffic shaping policies.

Architecture

This policy uses Google Guava cache, which offers a map to send responses. The cache must be enabled through feature flags on the Snaplex.

...

  • policy version to determine if the policy has been updated since the last save. An update to the policy will direct the flow to acquire a new HTTP response and overwrite the existing one.

Limitations

...

  • Each response cache can only contain 85 MB. The policy always returns the response, but any data over the limit renders the payload incomplete.

  • A response cache is not effective to use for POST and PUT HTTP methods because these operations are meant to alter the state of data, and hence should not be cached.

Settings

Parameter Name

Description

Default Value

Label

Required. The name for the API policy.

HTTP Respone Cache

When this policy should be applied

An expression-enabled field that determines the condition to be fulfilled for the API policy to execute.

For example, if the value in this field is request.method == "POST", the API policy is executed only if the request method is a POST.

N/A

Cache Interval

The time period of the current cache before it is refreshed.

1

Time Unit

The time unit for the Cache Interval value.

Hour

Use HTTP Request Headers to Create Cache Keys

Enables the use of specific headers to identify a cache.

Unselected

Use HTTP Request Query Parameter to Create Cache Keys

Enables the use of query parameters to identify a cache.

Unselected

Status

Specifies whether the API policy is enabled or disabled. 

Enabled

...