Proxy Caching Advanced: Cache by Principal - Plugin

Cache by Principalv3.16+

Cache responses to GET requests using the authenticated Principal to compose the cache key.

Set up the plugin

Add this section to your kong.yaml configuration file:

decK

kong.yaml

Copied!

_format_version: "3.0"
plugins:
  - name: proxy-cache-advanced
    config:
      response_code:
      - 200
      request_method:
      - GET
      content_type:
      - text/plain
      - application/json
      cache_ttl: 300
      cache_by_principal: true
      strategy: memory

Make the following request:

curl -i -X POST http://localhost:8001/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "proxy-cache-advanced",
      "config": {
        "response_code": [
          200
        ],
        "request_method": [
          "GET"
        ],
        "content_type": [
          "text/plain",
          "application/json"
        ],
        "cache_ttl": 300,
        "cache_by_principal": true,
        "strategy": "memory"
      }
    }
    '

Copied!

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "proxy-cache-advanced",
      "config": {
        "response_code": [
          200
        ],
        "request_method": [
          "GET"
        ],
        "content_type": [
          "text/plain",
          "application/json"
        ],
        "cache_ttl": 300,
        "cache_by_principal": true,
        "strategy": "memory"
      }
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
controlPlaneId: The id of the control plane.

See the Konnect Control Planes Config API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: proxy-cache-advanced
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: 'true'
config:
  response_code:
  - 200
  request_method:
  - GET
  content_type:
  - text/plain
  - application/json
  cache_ttl: 300
  cache_by_principal: true
  strategy: memory
plugin: proxy-cache-advanced
" | kubectl apply -f -

Copied!

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Copied!

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_proxy_cache_advanced" "my_proxy_cache_advanced" {
  enabled = true

  config = {
    response_code = [200]
    request_method = ["GET"]
    content_type = ["text/plain", "application/json"]
    cache_ttl = 300
    cache_by_principal = true
    strategy = "memory"
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}

Copied!

Add this section to your kong.yaml configuration file:

decK

kong.yaml

Copied!

_format_version: "3.0"
plugins:
  - name: proxy-cache-advanced
    service: serviceName|Id
    config:
      response_code:
      - 200
      request_method:
      - GET
      content_type:
      - text/plain
      - application/json
      cache_ttl: 300
      cache_by_principal: true
      strategy: memory

Make sure to replace the following placeholders with your own values:

serviceName|Id: The id or name of the service the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/services/{serviceName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "proxy-cache-advanced",
      "config": {
        "response_code": [
          200
        ],
        "request_method": [
          "GET"
        ],
        "content_type": [
          "text/plain",
          "application/json"
        ],
        "cache_ttl": 300,
        "cache_by_principal": true,
        "strategy": "memory"
      }
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

serviceName|Id: The id or name of the service the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/services/{serviceId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "proxy-cache-advanced",
      "config": {
        "response_code": [
          200
        ],
        "request_method": [
          "GET"
        ],
        "content_type": [
          "text/plain",
          "application/json"
        ],
        "cache_ttl": 300,
        "cache_by_principal": true,
        "strategy": "memory"
      }
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
controlPlaneId: The id of the control plane.
serviceId: The id of the service the plugin configuration will target.

See the Konnect Control Planes Config API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: proxy-cache-advanced
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  response_code:
  - 200
  request_method:
  - GET
  content_type:
  - text/plain
  - application/json
  cache_ttl: 300
  cache_by_principal: true
  strategy: memory
plugin: proxy-cache-advanced
" | kubectl apply -f -

Copied!

Next, apply the KongPlugin resource by annotating the service resource:

kubectl annotate -n kong service SERVICE_NAME konghq.com/plugins=proxy-cache-advanced

Copied!

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Copied!

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_proxy_cache_advanced" "my_proxy_cache_advanced" {
  enabled = true

  config = {
    response_code = [200]
    request_method = ["GET"]
    content_type = ["text/plain", "application/json"]
    cache_ttl = 300
    cache_by_principal = true
    strategy = "memory"
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  service = {
    id = konnect_gateway_service.my_service.id
  }
}

Copied!

Add this section to your kong.yaml configuration file:

decK

kong.yaml

Copied!

_format_version: "3.0"
plugins:
  - name: proxy-cache-advanced
    route: routeName|Id
    config:
      response_code:
      - 200
      request_method:
      - GET
      content_type:
      - text/plain
      - application/json
      cache_ttl: 300
      cache_by_principal: true
      strategy: memory

Make sure to replace the following placeholders with your own values:

routeName|Id: The id or name of the route the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/routes/{routeName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "proxy-cache-advanced",
      "config": {
        "response_code": [
          200
        ],
        "request_method": [
          "GET"
        ],
        "content_type": [
          "text/plain",
          "application/json"
        ],
        "cache_ttl": 300,
        "cache_by_principal": true,
        "strategy": "memory"
      }
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

routeName|Id: The id or name of the route the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/routes/{routeId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "proxy-cache-advanced",
      "config": {
        "response_code": [
          200
        ],
        "request_method": [
          "GET"
        ],
        "content_type": [
          "text/plain",
          "application/json"
        ],
        "cache_ttl": 300,
        "cache_by_principal": true,
        "strategy": "memory"
      }
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
controlPlaneId: The id of the control plane.
routeId: The id of the route the plugin configuration will target.

See the Konnect Control Planes Config API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: proxy-cache-advanced
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  response_code:
  - 200
  request_method:
  - GET
  content_type:
  - text/plain
  - application/json
  cache_ttl: 300
  cache_by_principal: true
  strategy: memory
plugin: proxy-cache-advanced
" | kubectl apply -f -

Copied!

Next, apply the KongPlugin resource by annotating the httproute or ingress resource:

kubectl annotate -n kong httproute  konghq.com/plugins=proxy-cache-advanced

Copied!

kubectl annotate -n kong ingress  konghq.com/plugins=proxy-cache-advanced

Copied!

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Copied!

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_proxy_cache_advanced" "my_proxy_cache_advanced" {
  enabled = true

  config = {
    response_code = [200]
    request_method = ["GET"]
    content_type = ["text/plain", "application/json"]
    cache_ttl = 300
    cache_by_principal = true
    strategy = "memory"
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  route = {
    id = konnect_gateway_route.my_route.id
  }
}

Copied!

Add this section to your kong.yaml configuration file:

decK

kong.yaml

Copied!

_format_version: "3.0"
plugins:
  - name: proxy-cache-advanced
    consumer: consumerName|Id
    config:
      response_code:
      - 200
      request_method:
      - GET
      content_type:
      - text/plain
      - application/json
      cache_ttl: 300
      cache_by_principal: true
      strategy: memory

Make sure to replace the following placeholders with your own values:

consumerName|Id: The id or name of the consumer the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/consumers/{consumerName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "proxy-cache-advanced",
      "config": {
        "response_code": [
          200
        ],
        "request_method": [
          "GET"
        ],
        "content_type": [
          "text/plain",
          "application/json"
        ],
        "cache_ttl": 300,
        "cache_by_principal": true,
        "strategy": "memory"
      }
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

consumerName|Id: The id or name of the consumer the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumers/{consumerId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "proxy-cache-advanced",
      "config": {
        "response_code": [
          200
        ],
        "request_method": [
          "GET"
        ],
        "content_type": [
          "text/plain",
          "application/json"
        ],
        "cache_ttl": 300,
        "cache_by_principal": true,
        "strategy": "memory"
      }
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
controlPlaneId: The id of the control plane.
consumerId: The id of the consumer the plugin configuration will target.

See the Konnect Control Planes Config API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: proxy-cache-advanced
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  response_code:
  - 200
  request_method:
  - GET
  content_type:
  - text/plain
  - application/json
  cache_ttl: 300
  cache_by_principal: true
  strategy: memory
plugin: proxy-cache-advanced
" | kubectl apply -f -

Copied!

Next, apply the KongPlugin resource by annotating the KongConsumer resource:

kubectl annotate -n kong kongconsumer CONSUMER_NAME konghq.com/plugins=proxy-cache-advanced

Copied!

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Copied!

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_proxy_cache_advanced" "my_proxy_cache_advanced" {
  enabled = true

  config = {
    response_code = [200]
    request_method = ["GET"]
    content_type = ["text/plain", "application/json"]
    cache_ttl = 300
    cache_by_principal = true
    strategy = "memory"
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  consumer = {
    id = konnect_gateway_consumer.my_consumer.id
  }
}

Copied!

Add this section to your kong.yaml configuration file:

decK

kong.yaml

Copied!

_format_version: "3.0"
plugins:
  - name: proxy-cache-advanced
    consumer_group: consumerGroupName|Id
    config:
      response_code:
      - 200
      request_method:
      - GET
      content_type:
      - text/plain
      - application/json
      cache_ttl: 300
      cache_by_principal: true
      strategy: memory

Make sure to replace the following placeholders with your own values:

consumerGroupName|Id: The id or name of the consumer group the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/consumer_groups/{consumerGroupName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "proxy-cache-advanced",
      "config": {
        "response_code": [
          200
        ],
        "request_method": [
          "GET"
        ],
        "content_type": [
          "text/plain",
          "application/json"
        ],
        "cache_ttl": 300,
        "cache_by_principal": true,
        "strategy": "memory"
      }
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

consumerGroupName|Id: The id or name of the consumer group the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups/{consumerGroupId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "proxy-cache-advanced",
      "config": {
        "response_code": [
          200
        ],
        "request_method": [
          "GET"
        ],
        "content_type": [
          "text/plain",
          "application/json"
        ],
        "cache_ttl": 300,
        "cache_by_principal": true,
        "strategy": "memory"
      }
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
controlPlaneId: The id of the control plane.
consumerGroupId: The id of the consumer group the plugin configuration will target.

See the Konnect Control Planes Config API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: proxy-cache-advanced
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  response_code:
  - 200
  request_method:
  - GET
  content_type:
  - text/plain
  - application/json
  cache_ttl: 300
  cache_by_principal: true
  strategy: memory
plugin: proxy-cache-advanced
" | kubectl apply -f -

Copied!

Next, apply the KongPlugin resource by annotating the KongConsumerGroup resource:

kubectl annotate -n kong kongconsumergroup CONSUMERGROUP_NAME konghq.com/plugins=proxy-cache-advanced

Copied!

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Copied!

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_proxy_cache_advanced" "my_proxy_cache_advanced" {
  enabled = true

  config = {
    response_code = [200]
    request_method = ["GET"]
    content_type = ["text/plain", "application/json"]
    cache_ttl = 300
    cache_by_principal = true
    strategy = "memory"
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  consumer_group = {
    id = konnect_gateway_consumer_group.my_consumer_group.id
  }
}

Copied!

Proxy Caching Advanced

Cache by Principalv3.16+

Set up the plugin

Help us make these docs great!

Still need help?