Configuration

configobject
Hide Child Parameters
auth_passwordstring

The password to authenticate with, if the forward proxy is protected
by basic authentication.
This field is encrypted.
This field is referenceable.

auth_usernamestring

The username to authenticate with, if the forward proxy is protected
by basic authentication.
This field is referenceable.

http_proxy_hoststring

A string representing a host name, such as example.com.

http_proxy_portinteger

An integer representing a port number between 0 and 65535, inclusive.

>= 0<= 65535

https_proxy_hoststring

A string representing a host name, such as example.com.

https_proxy_portinteger

An integer representing a port number between 0 and 65535, inclusive.

>= 0<= 65535

https_verifyboolean

Whether the server certificate will be verified according to the CA certificates specified in lua_ssl_trusted_certificate.

Default:false

proxy_schemestring

The proxy scheme to use when connecting. Only http is supported.

Allowed values:http

Default:http

x_headersstring

Determines how to handle headers when forwarding the request.

Allowed values:appenddeletetransparent

Default:append

consumerobject

If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.

* Additional properties are NOT allowed.
Hide Child Parameters
idstring
protocolsarray[string]

A set of strings representing HTTP protocols.

Allowed values:grpcgrpcshttphttps

Default:grpc, grpcs, http, https

routeobject

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

* Additional properties are NOT allowed.
Hide Child Parameters
idstring
serviceobject

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

* Additional properties are NOT allowed.
Hide Child Parameters
idstring

Did this doc help?

Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!