You are browsing documentation for an outdated plugin version.
Configuration
This plugin is compatible with DB-less mode.
Parameters
Here's a list of all the parameters which can be used in this plugin's configuration:
-
string required
The name of the plugin, in this case
proxy-cache
.- If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is
name
. - If using the KongPlugin object in Kubernetes, the field is
plugin
.
- If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is
-
string
The name or ID of the service the plugin targets. Set one of these parameters if adding the plugin to a service through the top-level
/plugins
endpoint. Not required if using/services/{serviceName|Id}/plugins
. -
string
The name or ID of the route the plugin targets. Set one of these parameters if adding the plugin to a route through the top-level
/plugins
endpoint. Not required if using/routes/{routeName|Id}/plugins
. -
string
The name or ID of the consumer the plugin targets. Set one of these parameters if adding the plugin to a consumer through the top-level
/plugins
endpoint. Not required if using/consumers/{consumerName|Id}/plugins
. -
boolean default:
true
Whether this plugin will be applied.
-
record required
-
array of type
integer
required default:200, 301, 404
len_min:1
Upstream response status code considered cacheable.
-
array of type
string
required default:GET, HEAD
Must be one of:HEAD
,GET
,POST
,PATCH
,PUT
Downstream request methods considered cacheable.
-
array of type
string
required default:text/plain, application/json
Upstream response content types considered cacheable. The plugin performs an exact match against each specified value; for example, if the upstream is expected to respond with a
application/json; charset=utf-8
content-type, the plugin configuration must contain said value or aBypass
cache status is returned.
-
integer default:
300
TTL, in seconds, of cache entities.
-
string required Must be one of:
memory
The backing data store in which to hold cache entities. The only accepted value is
memory
.
-
boolean required default:
false
When enabled, respect the Cache-Control behaviors defined in RFC7234.
-
integer
Number of seconds to keep resources in the storage backend. This value is independent of
cache_ttl
or resource TTLs defined by Cache-Control behaviors.
-
record required
-
array of type
string
Relevant query parameters considered for the cache key. If undefined, all params are taken into consideration.
-
array of type
string
Relevant headers considered for the cache key. If undefined, none of the headers are taken into consideration.
-