ResponseCache policy icon InvalidateCache policy

About | Element reference

What

Configures how the cached values should be purged from the cache.

Where

This policy can be attached in the following locations.

ProxyEndpoint TargetEndpoint
    PreFlow Flow PostFlow PreFlow Flow PostFlow    
Request    
    Response
    PostFlow Flow PreFlow PostFlow Flow PreFlow    

Element reference

The following lists the elements you can configure on this policy.

<InvalidateCache async="false" continueOnError="false" enabled="true" name="policy-name">
    <DisplayName>Policy Name</DisplayName>
    <FaultRules>rules_for_fault_handling</FaultRules>
    <Properties>property_elements</Properties>
    <CacheKey>
        <Prefix>prefix_string</Prefix>
        <KeyFragment ref="variable_reference"/>
        <KeyFragment>fragment_string</KeyFragment>
    </CacheKey>
    <CacheResource>cache_to_use</CacheResource>
    <Scope>scope_enumeration</Scope>
    <CacheContext>
        <APIProxyName>application_that_added_the_entry</APIProxyName>
        <ProxyName>proxy_for_which_data_was_cached</ProxyName>
        <TargetName>endpoint_for_which_data_was_cached</TargetName>
    </CacheContext>
    <PurgeChildEntries>true_to_purge_all_child_entries</PurgeChildEntries>
</InvalidateCache>

Your organization comes with a default cache. For more about the underlying data store, see Why Use a Cache?. For more about configuring caches, see Manage caches for an environment.

<InvalidateCache> attributes

Attribute Description Default Presence
async

true to specify that the policy should be run in a thread pool different than the pool servicing the request/response flow. Default is false.

This setting is only used for for internal optimization. Contact Apigee support at the Support Portal for more information.

false Optional
continueOnError

true to specify that flow execution should continue on a failure. Default is false.

Most policies are expected to return an error when a failure occurs (for example, when a quota is exceeded).

false Optional
name

Specifies the name of the policy, which is referenced in step elements to attach the policy to a flow. Characters you can use in the name are restricted to: A-Z0-9._\-$ %.

  Required

<CacheContext>/<APIProxyName> element

Specifies the name of the application that added the cache entry.

<APIProxyName>application_that_added_the_entry</APIProxyName>

Attributes

Attribute Description Default Presence Type
ref Variable with the application name. N/A Optional String
 

<CacheContext> element

Specifies how to construct a cache key when a Prefix element value is not specified, or to clear cache entries added by another API proxy.

<CacheContext>
  <ApplicationName ref="">{0,1}</ApplicationName>
  <TargetName ref="">{0,1}</TargetName>
  <ProxyName ref="">{0,1}</ProxyName>
</CacheContext>

Used to construct the CacheKey. Values for APIProxyName, ProxyName and TargetName are mandatory in the following cases: When a CacheKey Prefix (that is, a custom prefix) is not used To clear cache entries added by another API proxy.

<CacheKey> element

Configures a unique pointer to a piece of data stored in the cache.

<CacheKey>
    <Prefix>string</Prefix>
    <KeyFragment ref="variable_name" />
    <KeyFragment>literal_string</KeyFragment>
</CacheKey>

Default:

N/A

Presence:

Required

Type:

N/A

<CacheKey> constructs the name of each piece of data stored in the cache.

At runtime, <KeyFragment> values are prepended with either the <Scope> element value or <Prefix> value. For example, the following results in a cache key of UserToken__apiAccessToken__<value_of_client_id>:

<CacheKey>
    <Prefix>UserToken</Prefix>
    <KeyFragment>apiAccessToken</KeyFragment>
    <KeyFragment ref="request.queryparam.client_id" />
</CacheKey>

You use the <CacheKey> element in conjunction with <Prefix> and <Scope>. For more information, see Working with cache keys.

<CacheResource> element

Specifies the cache where messages should be stored. A default cache is available.

<CacheResource>cache_to_use</CacheResource>

Default:

N/A

Presence:

Optional

Type:

String

For more about configuring caches, see Manage caches for an environment.

<CacheKey>/<KeyFragment> element

Specifies a value that should be included in the cache key, creating a namespace for matching requests to cached responses.

<KeyFragment ref="variable_name"/>
<KeyFragment>literal_string</KeyFragment>

Default:

N/A

Presence:

Optional

Type:

N/A

This can be a key (a static name that you provide) or a value (a dynamic entry set by referencing a variable). All specified fragments combined (plus the prefix) are concatenated to create the cache key.

<KeyFragment>apiAccessToken</KeyFragment>
<KeyFragment ref="request.queryparam.client_id" />

You use the <KeyFragment> element in conjunction with <Prefix> and <Scope>. For more information, see Working with cache keys.

Attributes

Attribute Description Default Presence Type
ref The variable from which to get the value. Should not be used if this element contains a literal value. N/A Optional String
 

<CacheKey>/<Prefix> element

Specifies a value to use as a cache key prefix.

<Prefix>prefix_string</Prefix>

Default:

N/A

Presence:

Optional

Type:

String

Use this value instead of <Scope> when you want to specify your own value rather than a <Scope> -enumerated value. If defined, <Prefix> prepends the cache key value for entries written to the cache. A <Prefix> element value overrides a <Scope> element value.

You use the <Prefix> element in conjunction with <CacheKey> and <Scope>. For more information, see Working with cache keys.

<CacheContext>/<ProxyName> element

Specifies the name of the proxy for which the data was cached.

<ProxyName>proxy_for_which_data_was_cached</ProxyName>

Default:

N/A

Presence:

Optional

Type:

String

Attributes

Attribute Description Default Presence Type
ref The variable from which to get the value. Should not be used if this element contains a literal value. N/A Optional String
 

<PurgeChildEntries> element

true to purge child cache entries when invalidating the cache. Default is false .

<PurgeChildEntries>true_to_purge_child_entries</PurgeChildEntries>

Default:

false

Presence:

Optional

Type:

Boolean

<Scope> element

Enumeration used to construct a prefix for a cache key when a <Prefix> element is not provided in the <CacheKey> element.

<Scope>scope_enumeration</Scope>

Default:

"Exclusive"

Presence:

Optional

Type:

String

The <Scope> setting determines a cache key that is prepended according to the <Scope> value. For example, a cache key would take the following form when scope is set to Exclusive : orgName__envName__applicationName__deployedRevisionNumber__proxy|TargetName__ [ serializedCacheKey ].

If a <Prefix> element is present in <CacheKey>, it supercedes a <Scope> element value. Valid values include the enumerations below.

You use the <Scope> element in conjunction with <CacheKey> and <Prefix>. For more information, see Working with cache keys.

Acceptable values

Scope Value Description
Global

Cache key is shared across all API proxies deployed in the environment. Cache key is prepended in the form  orgName __ envName __.

If you define a <CacheKey> entry with the <KeyFragment> apiAccessToken and a <Global> scope, each entry is stored as orgName__envName__apiAccessToken, followed by the serialized value of the access token. For an API proxy deployed in an environment called 'test' in an organization called 'apifactory', access tokens would be stored under the following cache key: apifactory__test__apiAccessToken.

Application

API proxy name is used as the prefix.

Cache key is prepended in the form orgName__envName__applicationName.

Proxy

ProxyEndpoint configuration is used as the prefix.

Cache key is prepended in the form orgName__envName__applicationName__deployedRevisionNumber__proxyEndpointName .

Target

TargetEndpoint configuration is used as the prefix.

Cache key prepended in the form orgName__envName__applicationName__deployedRevisionNumber__targetEndpointName .

Exclusive

Default. This is the most specific, and therefore presents minimal risk of namespace collisions within a given cache.

Prefix is one of two forms:

  • If the policy is attached to the ProxyEndpoint flow, prefix is of the form ApiProxyName_ProxyEndpointName.
  • If the policy is attached at TargetEndpoint, prefix is of the form ApiProxyName_TargetName.

Cache key prepended in the form orgName__envName__applicationName__deployedRevisionNumber__proxyNameITargetName

For example, the full string might look like this:

apifactory__test__weatherapi__16__default__apiAccessToken
.

<CacheContext>/<TargetName> element

Specifies the name of the target endpoint for which the data was cached.

<TargetName>endpoint_for_which_data_was_cached</TargetName>

Default:

N/A

Presence:

Optional

Type:

String

Attributes

Attribute Description Default Presence Type
ref The variable from which to get the value. Should not be used if this element contains a literal value. N/A Optional String
 

 

Help or comments?

  • Something's not working: See Apigee Support
  • Something's wrong with the docs: Click Send Feedback in the lower right.
    (Incorrect? Unclear? Broken link? Typo?)