Build a response from multiple APIsv3.10+
Configure the Request Callout plugin to call multiple APIs and build a response with elements from different responses.
In this example, we’ll get a UUID from http://httpbin.org/uuid
and an origin URL from http://httpbin.org/anything
.
Add this section to your declarative configuration file:
_format_version: "3.0"
plugins:
- name: request-callout
config:
callouts:
- name: c1
request:
url: http://httpbin.org/uuid
method: GET
response:
body:
decode: true
- name: c2
request:
url: http://httpbin.org/anything
method: GET
response:
body:
decode: true
upstream:
by_lua: kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid,
origin = kong.ctx.shared.callouts.c2.response.body.url})
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": "c1",
"request": {
"url": "http://httpbin.org/uuid",
"method": "GET"
},
"response": {
"body": {
"decode": true
}
}
},
{
"name": "c2",
"request": {
"url": "http://httpbin.org/anything",
"method": "GET"
},
"response": {
"body": {
"decode": true
}
}
}
],
"upstream": {
"by_lua": "kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid, origin = kong.ctx.shared.callouts.c2.response.body.url})"
}
}
}
'
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": "c1",
"request": {
"url": "http://httpbin.org/uuid",
"method": "GET"
},
"response": {
"body": {
"decode": true
}
}
},
{
"name": "c2",
"request": {
"url": "http://httpbin.org/anything",
"method": "GET"
},
"response": {
"body": {
"decode": true
}
}
}
],
"upstream": {
"by_lua": "kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid, origin = kong.ctx.shared.callouts.c2.response.body.url})"
}
}
}
'
Make sure to replace the following placeholders with your own values:
-
region
: Geographic region where your Kong Konnect is hosted and operates. -
controlPlaneId
: Theid
of the control plane. -
KONNECT_TOKEN
: Your Personal Access Token (PAT) associated with your Konnect account.
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
labels:
global: 'true'
config:
callouts:
- name: c1
request:
url: http://httpbin.org/uuid
method: GET
response:
body:
decode: true
- name: c2
request:
url: http://httpbin.org/anything
method: GET
response:
body:
decode: true
upstream:
by_lua: kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid,
origin = kong.ctx.shared.callouts.c2.response.body.url})
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 = "c1"
request = {
url = "http://httpbin.org/uuid"
method = "GET"
}
response = {
body = {
decode = true
}
}
},
{
name = "c2"
request = {
url = "http://httpbin.org/anything"
method = "GET"
}
response = {
body = {
decode = true
}
}
} ]
upstream = {
by_lua = "kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid, origin = kong.ctx.shared.callouts.c2.response.body.url})"
}
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}
Add this section to your declarative configuration file:
_format_version: "3.0"
plugins:
- name: request-callout
service: serviceName|Id
config:
callouts:
- name: c1
request:
url: http://httpbin.org/uuid
method: GET
response:
body:
decode: true
- name: c2
request:
url: http://httpbin.org/anything
method: GET
response:
body:
decode: true
upstream:
by_lua: kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid,
origin = kong.ctx.shared.callouts.c2.response.body.url})
Make sure to replace the following placeholders with your own values:
-
serviceName|Id
: Theid
orname
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": "request-callout",
"config": {
"callouts": [
{
"name": "c1",
"request": {
"url": "http://httpbin.org/uuid",
"method": "GET"
},
"response": {
"body": {
"decode": true
}
}
},
{
"name": "c2",
"request": {
"url": "http://httpbin.org/anything",
"method": "GET"
},
"response": {
"body": {
"decode": true
}
}
}
],
"upstream": {
"by_lua": "kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid, origin = kong.ctx.shared.callouts.c2.response.body.url})"
}
}
}
'
Make sure to replace the following placeholders with your own values:
-
serviceName|Id
: Theid
orname
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": "request-callout",
"config": {
"callouts": [
{
"name": "c1",
"request": {
"url": "http://httpbin.org/uuid",
"method": "GET"
},
"response": {
"body": {
"decode": true
}
}
},
{
"name": "c2",
"request": {
"url": "http://httpbin.org/anything",
"method": "GET"
},
"response": {
"body": {
"decode": true
}
}
}
],
"upstream": {
"by_lua": "kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid, origin = kong.ctx.shared.callouts.c2.response.body.url})"
}
}
}
'
Make sure to replace the following placeholders with your own values:
-
region
: Geographic region where your Kong Konnect is hosted and operates. -
controlPlaneId
: Theid
of the control plane. -
KONNECT_TOKEN
: Your Personal Access Token (PAT) associated with your Konnect account. -
serviceId
: Theid
of 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
config:
callouts:
- name: c1
request:
url: http://httpbin.org/uuid
method: GET
response:
body:
decode: true
- name: c2
request:
url: http://httpbin.org/anything
method: GET
response:
body:
decode: true
upstream:
by_lua: kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid,
origin = kong.ctx.shared.callouts.c2.response.body.url})
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 = "c1"
request = {
url = "http://httpbin.org/uuid"
method = "GET"
}
response = {
body = {
decode = true
}
}
},
{
name = "c2"
request = {
url = "http://httpbin.org/anything"
method = "GET"
}
response = {
body = {
decode = true
}
}
} ]
upstream = {
by_lua = "kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid, origin = kong.ctx.shared.callouts.c2.response.body.url})"
}
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
service = {
id = konnect_gateway_service.my_service.id
}
}
Add this section to your declarative configuration file:
_format_version: "3.0"
plugins:
- name: request-callout
route: routeName|Id
config:
callouts:
- name: c1
request:
url: http://httpbin.org/uuid
method: GET
response:
body:
decode: true
- name: c2
request:
url: http://httpbin.org/anything
method: GET
response:
body:
decode: true
upstream:
by_lua: kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid,
origin = kong.ctx.shared.callouts.c2.response.body.url})
Make sure to replace the following placeholders with your own values:
-
routeName|Id
: Theid
orname
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": "request-callout",
"config": {
"callouts": [
{
"name": "c1",
"request": {
"url": "http://httpbin.org/uuid",
"method": "GET"
},
"response": {
"body": {
"decode": true
}
}
},
{
"name": "c2",
"request": {
"url": "http://httpbin.org/anything",
"method": "GET"
},
"response": {
"body": {
"decode": true
}
}
}
],
"upstream": {
"by_lua": "kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid, origin = kong.ctx.shared.callouts.c2.response.body.url})"
}
}
}
'
Make sure to replace the following placeholders with your own values:
-
routeName|Id
: Theid
orname
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": "request-callout",
"config": {
"callouts": [
{
"name": "c1",
"request": {
"url": "http://httpbin.org/uuid",
"method": "GET"
},
"response": {
"body": {
"decode": true
}
}
},
{
"name": "c2",
"request": {
"url": "http://httpbin.org/anything",
"method": "GET"
},
"response": {
"body": {
"decode": true
}
}
}
],
"upstream": {
"by_lua": "kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid, origin = kong.ctx.shared.callouts.c2.response.body.url})"
}
}
}
'
Make sure to replace the following placeholders with your own values:
-
region
: Geographic region where your Kong Konnect is hosted and operates. -
controlPlaneId
: Theid
of the control plane. -
KONNECT_TOKEN
: Your Personal Access Token (PAT) associated with your Konnect account. -
routeId
: Theid
of 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
config:
callouts:
- name: c1
request:
url: http://httpbin.org/uuid
method: GET
response:
body:
decode: true
- name: c2
request:
url: http://httpbin.org/anything
method: GET
response:
body:
decode: true
upstream:
by_lua: kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid,
origin = kong.ctx.shared.callouts.c2.response.body.url})
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 = "c1"
request = {
url = "http://httpbin.org/uuid"
method = "GET"
}
response = {
body = {
decode = true
}
}
},
{
name = "c2"
request = {
url = "http://httpbin.org/anything"
method = "GET"
}
response = {
body = {
decode = true
}
}
} ]
upstream = {
by_lua = "kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid, origin = kong.ctx.shared.callouts.c2.response.body.url})"
}
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
route = {
id = konnect_gateway_route.my_route.id
}
}
Add this section to your declarative configuration file:
_format_version: "3.0"
plugins:
- name: request-callout
consumer: consumerName|Id
config:
callouts:
- name: c1
request:
url: http://httpbin.org/uuid
method: GET
response:
body:
decode: true
- name: c2
request:
url: http://httpbin.org/anything
method: GET
response:
body:
decode: true
upstream:
by_lua: kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid,
origin = kong.ctx.shared.callouts.c2.response.body.url})
Make sure to replace the following placeholders with your own values:
-
consumerName|Id
: Theid
orname
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": "request-callout",
"config": {
"callouts": [
{
"name": "c1",
"request": {
"url": "http://httpbin.org/uuid",
"method": "GET"
},
"response": {
"body": {
"decode": true
}
}
},
{
"name": "c2",
"request": {
"url": "http://httpbin.org/anything",
"method": "GET"
},
"response": {
"body": {
"decode": true
}
}
}
],
"upstream": {
"by_lua": "kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid, origin = kong.ctx.shared.callouts.c2.response.body.url})"
}
}
}
'
Make sure to replace the following placeholders with your own values:
-
consumerName|Id
: Theid
orname
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": "request-callout",
"config": {
"callouts": [
{
"name": "c1",
"request": {
"url": "http://httpbin.org/uuid",
"method": "GET"
},
"response": {
"body": {
"decode": true
}
}
},
{
"name": "c2",
"request": {
"url": "http://httpbin.org/anything",
"method": "GET"
},
"response": {
"body": {
"decode": true
}
}
}
],
"upstream": {
"by_lua": "kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid, origin = kong.ctx.shared.callouts.c2.response.body.url})"
}
}
}
'
Make sure to replace the following placeholders with your own values:
-
region
: Geographic region where your Kong Konnect is hosted and operates. -
controlPlaneId
: Theid
of the control plane. -
KONNECT_TOKEN
: Your Personal Access Token (PAT) associated with your Konnect account. -
consumerId
: Theid
of 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
config:
callouts:
- name: c1
request:
url: http://httpbin.org/uuid
method: GET
response:
body:
decode: true
- name: c2
request:
url: http://httpbin.org/anything
method: GET
response:
body:
decode: true
upstream:
by_lua: kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid,
origin = kong.ctx.shared.callouts.c2.response.body.url})
plugin: request-callout
" | kubectl apply -f -
Next, apply the KongPlugin
resource by annotating the KongConsumer
resource:
kubectl annotate -n kong 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 = "c1"
request = {
url = "http://httpbin.org/uuid"
method = "GET"
}
response = {
body = {
decode = true
}
}
},
{
name = "c2"
request = {
url = "http://httpbin.org/anything"
method = "GET"
}
response = {
body = {
decode = true
}
}
} ]
upstream = {
by_lua = "kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid, origin = kong.ctx.shared.callouts.c2.response.body.url})"
}
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
consumer = {
id = konnect_gateway_consumer.my_consumer.id
}
}
Add this section to your declarative configuration file:
_format_version: "3.0"
plugins:
- name: request-callout
consumer_group: consumerGroupName|Id
config:
callouts:
- name: c1
request:
url: http://httpbin.org/uuid
method: GET
response:
body:
decode: true
- name: c2
request:
url: http://httpbin.org/anything
method: GET
response:
body:
decode: true
upstream:
by_lua: kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid,
origin = kong.ctx.shared.callouts.c2.response.body.url})
Make sure to replace the following placeholders with your own values:
-
consumerGroupName|Id
: Theid
orname
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": "request-callout",
"config": {
"callouts": [
{
"name": "c1",
"request": {
"url": "http://httpbin.org/uuid",
"method": "GET"
},
"response": {
"body": {
"decode": true
}
}
},
{
"name": "c2",
"request": {
"url": "http://httpbin.org/anything",
"method": "GET"
},
"response": {
"body": {
"decode": true
}
}
}
],
"upstream": {
"by_lua": "kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid, origin = kong.ctx.shared.callouts.c2.response.body.url})"
}
}
}
'
Make sure to replace the following placeholders with your own values:
-
consumerGroupName|Id
: Theid
orname
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": "request-callout",
"config": {
"callouts": [
{
"name": "c1",
"request": {
"url": "http://httpbin.org/uuid",
"method": "GET"
},
"response": {
"body": {
"decode": true
}
}
},
{
"name": "c2",
"request": {
"url": "http://httpbin.org/anything",
"method": "GET"
},
"response": {
"body": {
"decode": true
}
}
}
],
"upstream": {
"by_lua": "kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid, origin = kong.ctx.shared.callouts.c2.response.body.url})"
}
}
}
'
Make sure to replace the following placeholders with your own values:
-
region
: Geographic region where your Kong Konnect is hosted and operates. -
controlPlaneId
: Theid
of the control plane. -
KONNECT_TOKEN
: Your Personal Access Token (PAT) associated with your Konnect account. -
consumerGroupId
: Theid
of 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
config:
callouts:
- name: c1
request:
url: http://httpbin.org/uuid
method: GET
response:
body:
decode: true
- name: c2
request:
url: http://httpbin.org/anything
method: GET
response:
body:
decode: true
upstream:
by_lua: kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid,
origin = kong.ctx.shared.callouts.c2.response.body.url})
plugin: request-callout
" | kubectl apply -f -
Next, apply the KongPlugin
resource by annotating the KongConsumerGroup
resource:
kubectl annotate -n kong 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 = "c1"
request = {
url = "http://httpbin.org/uuid"
method = "GET"
}
response = {
body = {
decode = true
}
}
},
{
name = "c2"
request = {
url = "http://httpbin.org/anything"
method = "GET"
}
response = {
body = {
decode = true
}
}
} ]
upstream = {
by_lua = "kong.response.exit(200, { uuid = kong.ctx.shared.callouts.c1.response.body.uuid, origin = kong.ctx.shared.callouts.c2.response.body.url})"
}
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
consumer_group = {
id = konnect_gateway_consumer_group.my_consumer_group.id
}
}