You are browsing documentation for an outdated plugin version.
Configuration
This plugin is compatible with DB-less mode.
Compatible protocols
The Forward Proxy Advanced plugin is compatible with the following protocols:
grpc
, grpcs
, http
, https
Parameters
Here's a list of all the parameters which can be used in this plugin's configuration:
-
string required
The 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
-
string
The 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
. -
string
The 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
. -
string
The 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
. -
boolean default:
true
Whether this plugin will be applied.
-
record required
-
string required default:
append
Must be one of:append
,transparent
,delete
-
string
The HTTP hostname or IP address of the forward proxy to which to connect. Required if
http_proxy_port
is set.At least one of
http_proxy_host
orhttps_proxy_host
must be specified.If
http_proxy_host
isn’t set, the plugin falls back to the value configured inhttps_proxy_host
.
-
integer between:
0
65535
The TCP port of the HTTP forward proxy to which to connect. Required if
http_proxy_host
is set.At least one of
http_proxy_port
orhttps_proxy_port
must be specified.If
http_proxy_port
isn’t set, the plugin falls back to the value configured inhttps_proxy_port
.
-
string
The HTTPS hostname or IP address of the forward proxy to which to connect. Required if
https_proxy_port
is set.At least one of
http_proxy_host
orhttps_proxy_host
must be specified.If
https_proxy_host
isn’t set, the plugin falls back to the value configured inhttp_proxy_host
.
-
integer between:
0
65535
The TCP port of the HTTPS forward proxy to which to connect. Required if
https_proxy_host
is set.At least one of
http_proxy_port
orhttps_proxy_port
must be specified.If
https_proxy_port
isn’t set, the plugin falls back to the value configured inhttp_proxy_port
.
-
string required default:
http
Must be one of:http
The proxy scheme to use when connecting. Only
http
is supported.
-
string referenceable
The username to authenticate with, if the forward proxy is protected by basic authentication.
-
string referenceable
The password to authenticate with, if the forward proxy is protected by basic authentication.
-
boolean required default:
false
Whether the server certificate will be verified according to the CA certificates specified in lua_ssl_trusted_certificate.
-
-
string
Deprecation notice:
-
integer
Deprecation notice: