Configuration

configobject
Hide Child Parameters
clientobject
Hide Child Parameters
binaryobject
Hide Child Parameters
schemastringrequired

Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type.

typestringrequired

The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported.

Allowed values:draft4

textobject
Hide Child Parameters
schemastringrequired

Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type.

typestringrequired

The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported.

Allowed values:draft4

upstreamobject
Hide Child Parameters
binaryobject
Hide Child Parameters
schemastringrequired

Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type.

typestringrequired

The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported.

Allowed values:draft4

textobject
Hide Child Parameters
schemastringrequired

Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type.

typestringrequired

The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported.

Allowed values:draft4

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 list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.

Allowed values:wswss

Default:ws, wss

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!