---
title: "Update a ProxyCache plugin"
method: PUT
path: "/{workspace}/plugins/{PluginId}#ProxyCache"
tags: ["Plugins"]
---

# Update a ProxyCache plugin

`PUT /{workspace}/plugins/{PluginId}#ProxyCache`

Update a ProxyCache plugin

## Request body

- ProxyCachePlugin — A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the [Kong Hub](https://docs.konghq.com/hub/). When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the `service` and `consumer` fields.
  - `condition` string, nullable — An expression used for conditional control over plugin execution. If the expression evaluates to `true` during the request flow, the plugin is executed; otherwise, it is skipped.
  - `created_at` integer, nullable — Unix epoch when the resource was created.
  - `enabled` boolean, nullable — Whether the plugin is applied.
  - `id` string, nullable — A string representing a UUID (universally unique identifier).
  - `instance_name` string, nullable — A unique string representing a UTF-8 encoded name.
  - `name` 'proxy-cache', required — The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.
  - `ordering` object, nullable
    - `after` object
      - `access` string[]
    - `before` object
      - `access` string[]
  - `partials` object[] — A list of partials to be used by the plugin.
    - `id` string — A string representing a UUID (universally unique identifier).
    - `name` string — A unique string representing a UTF-8 encoded name.
    - `path` string
  - `tags` string[], nullable — An optional set of strings associated with the Plugin for grouping and filtering.
  - `updated_at` integer, nullable — Unix epoch when the resource was last updated.
  - `config` object, required
    - `cache_control` boolean — When enabled, respect the Cache-Control behaviors defined in RFC7234.
    - `cache_ttl` integer — TTL, in seconds, of cache entities.
    - `content_type` string[] — Upstream response content types considered cacheable. The plugin performs an **exact match** against each specified value.
    - `ignore_uri_case` boolean
    - `memory` object
      - `dictionary_name` string — The name of the shared dictionary in which to hold cache entities when the memory strategy is selected. Note that this dictionary currently must be defined manually in the Kong Nginx template.
    - `request_method` string[] — Downstream request methods considered cacheable.
    - `response_code` integer[] — Upstream response status code considered cacheable.
    - `response_headers` object — Caching related diagnostic headers that should be included in cached responses
      - `X-Cache-Key` boolean
      - `X-Cache-Status` boolean
      - `age` boolean
    - `storage_ttl` 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.
    - `strategy` 'memory', required — The backing data store in which to hold cache entities.
    - `vary_headers` string[] — Relevant headers considered for the cache key. If undefined, none of the headers are taken into consideration.
    - `vary_query_params` string[] — Relevant query parameters considered for the cache key. If undefined, all params are taken into consideration.
  - `consumer` object — If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
    - `id` string
  - `consumer_group` object — If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
    - `id` string
  - `protocols` string[] — A set of strings representing protocols.
  - `route` object — If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
    - `id` string
  - `service` object — If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    - `id` string

## Response `200`

ProxyCache plugin

- ProxyCachePlugin — A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the [Kong Hub](https://docs.konghq.com/hub/). When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the `service` and `consumer` fields.
  - `condition` string, nullable — An expression used for conditional control over plugin execution. If the expression evaluates to `true` during the request flow, the plugin is executed; otherwise, it is skipped.
  - `created_at` integer, nullable — Unix epoch when the resource was created.
  - `enabled` boolean, nullable — Whether the plugin is applied.
  - `id` string, nullable — A string representing a UUID (universally unique identifier).
  - `instance_name` string, nullable — A unique string representing a UTF-8 encoded name.
  - `name` 'proxy-cache', required — The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.
  - `ordering` object, nullable
    - `after` object
      - `access` string[]
    - `before` object
      - `access` string[]
  - `partials` object[] — A list of partials to be used by the plugin.
    - `id` string — A string representing a UUID (universally unique identifier).
    - `name` string — A unique string representing a UTF-8 encoded name.
    - `path` string
  - `tags` string[], nullable — An optional set of strings associated with the Plugin for grouping and filtering.
  - `updated_at` integer, nullable — Unix epoch when the resource was last updated.
  - `config` object, required
    - `cache_control` boolean — When enabled, respect the Cache-Control behaviors defined in RFC7234.
    - `cache_ttl` integer — TTL, in seconds, of cache entities.
    - `content_type` string[] — Upstream response content types considered cacheable. The plugin performs an **exact match** against each specified value.
    - `ignore_uri_case` boolean
    - `memory` object
      - `dictionary_name` string — The name of the shared dictionary in which to hold cache entities when the memory strategy is selected. Note that this dictionary currently must be defined manually in the Kong Nginx template.
    - `request_method` string[] — Downstream request methods considered cacheable.
    - `response_code` integer[] — Upstream response status code considered cacheable.
    - `response_headers` object — Caching related diagnostic headers that should be included in cached responses
      - `X-Cache-Key` boolean
      - `X-Cache-Status` boolean
      - `age` boolean
    - `storage_ttl` 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.
    - `strategy` 'memory', required — The backing data store in which to hold cache entities.
    - `vary_headers` string[] — Relevant headers considered for the cache key. If undefined, none of the headers are taken into consideration.
    - `vary_query_params` string[] — Relevant query parameters considered for the cache key. If undefined, all params are taken into consideration.
  - `consumer` object — If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
    - `id` string
  - `consumer_group` object — If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
    - `id` string
  - `protocols` string[] — A set of strings representing protocols.
  - `route` object — If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
    - `id` string
  - `service` object — If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    - `id` string

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.net/kong/apis/kong-enterprise-admin-api.md) · [All operations](https://skmtc.net/kong/apis/kong-enterprise-admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kong/kong-enterprise-admin-api/revisions/28b1f8a59cdc/schema)