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:
-
name or plugin
string requiredThe name of the plugin, in this case
forward-proxy
.- 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
-
service.name or service.id
stringThe 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
. -
route.name or route.id
stringThe 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
. -
consumer.name or consumer.id
stringThe 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
. -
enabled
boolean default:true
Whether this plugin will be applied.
-
config
record required-
proxy_host
string requiredThis parameter is deprecated as of Kong Gateway 2.8.0.0 and is planned to be removed in a future release.
Usehttp_proxy_host
orhttps_proxy_host
instead.The hostname or IP address of the forward proxy to which to connect.
-
proxy_port
integer required between:0
65535
This parameter is deprecated as of Kong Gateway 2.8.0.0 and is planned to be removed in a future release.
Usehttp_proxy_host
orhttps_proxy_host
instead.The TCP port of the forward proxy to which to connect.
-
proxy_scheme
string required default:http
Must be one of:http
The proxy scheme to use when connecting. Only
http
is supported.
-
https_verify
boolean required default:false
Whether the server certificate will be verified according to the CA certificates specified in lua_ssl_trusted_certificate.
-