Customize a cache keyv3.10+
Configure the Request Callout plugin to cache response results in Redis with a custom key.
Environment variables
-
API_URL: The API endpoint to use to request a token.
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: request-callout
config:
callouts:
- name: call
request:
url: ${{ env "DECK_API_URL" }}
method: GET
by_lua: kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'
response:
body:
store: true
decode: true
cache:
strategy: redis
redis:
host: localhost
port: 6379
cache_ttl: 360
Make the following request:
curl -i -X POST http://localhost:8001/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "request-callout",
"config": {
"callouts": [
{
"name": "call",
"request": {
"url": "'$API_URL'",
"method": "GET",
"by_lua": "kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'"
},
"response": {
"body": {
"store": true,
"decode": true
}
}
}
],
"cache": {
"strategy": "redis",
"redis": {
"host": "localhost",
"port": 6379
},
"cache_ttl": 360
}
},
"tags": []
}
'
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": "request-callout",
"config": {
"callouts": [
{
"name": "call",
"request": {
"url": "'$API_URL'",
"method": "GET",
"by_lua": "kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'"
},
"response": {
"body": {
"store": true,
"decode": true
}
}
}
],
"cache": {
"strategy": "redis",
"redis": {
"host": "localhost",
"port": 6379
},
"cache_ttl": 360
}
},
"tags": []
}
'
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: Theidof the control plane.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
name: request-callout
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
labels:
global: 'true'
config:
callouts:
- name: call
request:
url: '$API_URL'
method: GET
by_lua: kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'
response:
body:
store: true
decode: true
cache:
strategy: redis
redis:
host: localhost
port: 6379
cache_ttl: 360
plugin: request-callout
" | kubectl apply -f -
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/"
}
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_request_callout" "my_request_callout" {
enabled = true
config = {
callouts = [
{
name = "call"
request = {
url = var.api_url
method = "GET"
by_lua = "kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'"
}
response = {
body = {
store = true
decode = true
}
}
} ]
cache = {
strategy = "redis"
redis = {
host = "localhost"
port = 6379
}
cache_ttl = 360
}
}
tags = []
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}
This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.
variable "api_url" {
type = string
}
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: request-callout
service: serviceName|Id
config:
callouts:
- name: call
request:
url: ${{ env "DECK_API_URL" }}
method: GET
by_lua: kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'
response:
body:
store: true
decode: true
cache:
strategy: redis
redis:
host: localhost
port: 6379
cache_ttl: 360
Make sure to replace the following placeholders with your own values:
-
serviceName|Id: Theidornameof 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": "request-callout",
"config": {
"callouts": [
{
"name": "call",
"request": {
"url": "'$API_URL'",
"method": "GET",
"by_lua": "kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'"
},
"response": {
"body": {
"store": true,
"decode": true
}
}
}
],
"cache": {
"strategy": "redis",
"redis": {
"host": "localhost",
"port": 6379
},
"cache_ttl": 360
}
},
"tags": []
}
'
Make sure to replace the following placeholders with your own values:
-
serviceName|Id: Theidornameof 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": "request-callout",
"config": {
"callouts": [
{
"name": "call",
"request": {
"url": "'$API_URL'",
"method": "GET",
"by_lua": "kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'"
},
"response": {
"body": {
"store": true,
"decode": true
}
}
}
],
"cache": {
"strategy": "redis",
"redis": {
"host": "localhost",
"port": 6379
},
"cache_ttl": 360
}
},
"tags": []
}
'
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: Theidof the control plane. -
serviceId: Theidof the service the plugin configuration will target.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: request-callout
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
config:
callouts:
- name: call
request:
url: '$API_URL'
method: GET
by_lua: kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'
response:
body:
store: true
decode: true
cache:
strategy: redis
redis:
host: localhost
port: 6379
cache_ttl: 360
plugin: request-callout
" | kubectl apply -f -
Next, apply the KongPlugin resource by annotating the service resource:
kubectl annotate -n kong service SERVICE_NAME konghq.com/plugins=request-callout
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/"
}
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_request_callout" "my_request_callout" {
enabled = true
config = {
callouts = [
{
name = "call"
request = {
url = var.api_url
method = "GET"
by_lua = "kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'"
}
response = {
body = {
store = true
decode = true
}
}
} ]
cache = {
strategy = "redis"
redis = {
host = "localhost"
port = 6379
}
cache_ttl = 360
}
}
tags = []
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
service = {
id = konnect_gateway_service.my_service.id
}
}
This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.
variable "api_url" {
type = string
}
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: request-callout
route: routeName|Id
config:
callouts:
- name: call
request:
url: ${{ env "DECK_API_URL" }}
method: GET
by_lua: kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'
response:
body:
store: true
decode: true
cache:
strategy: redis
redis:
host: localhost
port: 6379
cache_ttl: 360
Make sure to replace the following placeholders with your own values:
-
routeName|Id: Theidornameof 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": "request-callout",
"config": {
"callouts": [
{
"name": "call",
"request": {
"url": "'$API_URL'",
"method": "GET",
"by_lua": "kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'"
},
"response": {
"body": {
"store": true,
"decode": true
}
}
}
],
"cache": {
"strategy": "redis",
"redis": {
"host": "localhost",
"port": 6379
},
"cache_ttl": 360
}
},
"tags": []
}
'
Make sure to replace the following placeholders with your own values:
-
routeName|Id: Theidornameof 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": "request-callout",
"config": {
"callouts": [
{
"name": "call",
"request": {
"url": "'$API_URL'",
"method": "GET",
"by_lua": "kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'"
},
"response": {
"body": {
"store": true,
"decode": true
}
}
}
],
"cache": {
"strategy": "redis",
"redis": {
"host": "localhost",
"port": 6379
},
"cache_ttl": 360
}
},
"tags": []
}
'
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: Theidof the control plane. -
routeId: Theidof the route the plugin configuration will target.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: request-callout
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
config:
callouts:
- name: call
request:
url: '$API_URL'
method: GET
by_lua: kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'
response:
body:
store: true
decode: true
cache:
strategy: redis
redis:
host: localhost
port: 6379
cache_ttl: 360
plugin: request-callout
" | kubectl apply -f -
Next, apply the KongPlugin resource by annotating the httproute or ingress resource:
kubectl annotate -n kong httproute konghq.com/plugins=request-callout
kubectl annotate -n kong ingress konghq.com/plugins=request-callout
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/"
}
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_request_callout" "my_request_callout" {
enabled = true
config = {
callouts = [
{
name = "call"
request = {
url = var.api_url
method = "GET"
by_lua = "kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'"
}
response = {
body = {
store = true
decode = true
}
}
} ]
cache = {
strategy = "redis"
redis = {
host = "localhost"
port = 6379
}
cache_ttl = 360
}
}
tags = []
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
route = {
id = konnect_gateway_route.my_route.id
}
}
This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.
variable "api_url" {
type = string
}
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: request-callout
consumer: consumerName|Id
config:
callouts:
- name: call
request:
url: ${{ env "DECK_API_URL" }}
method: GET
by_lua: kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'
response:
body:
store: true
decode: true
cache:
strategy: redis
redis:
host: localhost
port: 6379
cache_ttl: 360
Make sure to replace the following placeholders with your own values:
-
consumerName|Id: Theidornameof 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": "request-callout",
"config": {
"callouts": [
{
"name": "call",
"request": {
"url": "'$API_URL'",
"method": "GET",
"by_lua": "kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'"
},
"response": {
"body": {
"store": true,
"decode": true
}
}
}
],
"cache": {
"strategy": "redis",
"redis": {
"host": "localhost",
"port": 6379
},
"cache_ttl": 360
}
},
"tags": []
}
'
Make sure to replace the following placeholders with your own values:
-
consumerName|Id: Theidornameof 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": "request-callout",
"config": {
"callouts": [
{
"name": "call",
"request": {
"url": "'$API_URL'",
"method": "GET",
"by_lua": "kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'"
},
"response": {
"body": {
"store": true,
"decode": true
}
}
}
],
"cache": {
"strategy": "redis",
"redis": {
"host": "localhost",
"port": 6379
},
"cache_ttl": 360
}
},
"tags": []
}
'
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: Theidof the control plane. -
consumerId: Theidof the consumer the plugin configuration will target.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: request-callout
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
config:
callouts:
- name: call
request:
url: '$API_URL'
method: GET
by_lua: kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'
response:
body:
store: true
decode: true
cache:
strategy: redis
redis:
host: localhost
port: 6379
cache_ttl: 360
plugin: request-callout
" | kubectl apply -f -
Next, apply the KongPlugin resource by annotating the KongConsumer resource:
kubectl annotate -n kong kongconsumer CONSUMER_NAME konghq.com/plugins=request-callout
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/"
}
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_request_callout" "my_request_callout" {
enabled = true
config = {
callouts = [
{
name = "call"
request = {
url = var.api_url
method = "GET"
by_lua = "kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'"
}
response = {
body = {
store = true
decode = true
}
}
} ]
cache = {
strategy = "redis"
redis = {
host = "localhost"
port = 6379
}
cache_ttl = 360
}
}
tags = []
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
consumer = {
id = konnect_gateway_consumer.my_consumer.id
}
}
This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.
variable "api_url" {
type = string
}
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: request-callout
consumer_group: consumerGroupName|Id
config:
callouts:
- name: call
request:
url: ${{ env "DECK_API_URL" }}
method: GET
by_lua: kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'
response:
body:
store: true
decode: true
cache:
strategy: redis
redis:
host: localhost
port: 6379
cache_ttl: 360
Make sure to replace the following placeholders with your own values:
-
consumerGroupName|Id: Theidornameof 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": "request-callout",
"config": {
"callouts": [
{
"name": "call",
"request": {
"url": "'$API_URL'",
"method": "GET",
"by_lua": "kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'"
},
"response": {
"body": {
"store": true,
"decode": true
}
}
}
],
"cache": {
"strategy": "redis",
"redis": {
"host": "localhost",
"port": 6379
},
"cache_ttl": 360
}
},
"tags": []
}
'
Make sure to replace the following placeholders with your own values:
-
consumerGroupName|Id: Theidornameof 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": "request-callout",
"config": {
"callouts": [
{
"name": "call",
"request": {
"url": "'$API_URL'",
"method": "GET",
"by_lua": "kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'"
},
"response": {
"body": {
"store": true,
"decode": true
}
}
}
],
"cache": {
"strategy": "redis",
"redis": {
"host": "localhost",
"port": 6379
},
"cache_ttl": 360
}
},
"tags": []
}
'
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: Theidof the control plane. -
consumerGroupId: Theidof the consumer group the plugin configuration will target.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: request-callout
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
config:
callouts:
- name: call
request:
url: '$API_URL'
method: GET
by_lua: kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'
response:
body:
store: true
decode: true
cache:
strategy: redis
redis:
host: localhost
port: 6379
cache_ttl: 360
plugin: request-callout
" | kubectl apply -f -
Next, apply the KongPlugin resource by annotating the KongConsumerGroup resource:
kubectl annotate -n kong kongconsumergroup CONSUMERGROUP_NAME konghq.com/plugins=request-callout
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/"
}
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_request_callout" "my_request_callout" {
enabled = true
config = {
callouts = [
{
name = "call"
request = {
url = var.api_url
method = "GET"
by_lua = "kong.ctx.shared.callouts.call.caching.cache_key = 'some_key'"
}
response = {
body = {
store = true
decode = true
}
}
} ]
cache = {
strategy = "redis"
redis = {
host = "localhost"
port = 6379
}
cache_ttl = 360
}
}
tags = []
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
consumer_group = {
id = konnect_gateway_consumer_group.my_consumer_group.id
}
}
This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.
variable "api_url" {
type = string
}