Configuration

configobject
Hide Child Parameters
allowed_content_typesarray[string]

List of allowed content types. The value can be configured with the charset parameter. For example, application/json; charset=UTF-8.

Default:application/json

body_schemastring

The request body schema specification. One of body_schema or parameter_schema must be specified.

content_type_parameter_validationboolean

Determines whether to enable parameters validation of request content-type.

Default:true

parameter_schemaarray[object]

Array of parameter validator specification. One of body_schema or parameter_schema must be specified.

Hide Child Parameters
explodeboolean

Required when schema and style are set. When explode is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters, this property has no effect.

instringrequired

The location of the parameter.

Allowed values:headerpathquery

namestringrequired

The name of the parameter. Parameter names are case-sensitive, and correspond to the parameter name used by the in property. If in is path, the name field MUST correspond to the named capture group from the configured route.

requiredbooleanrequired

Determines whether this parameter is mandatory.

schemastring

Required when style and explode are set. This is the schema defining the type used for the parameter. It is validated using draft4 for JSON Schema draft 4 compliant validator. In addition to being a valid JSON Schema, the parameter schema MUST have a top-level type property to enable proper deserialization before validating.

stylestring

Required when schema and explode are set. Describes how the parameter value will be deserialized depending on the type of the parameter value.

Allowed values:deepObjectformlabelmatrixpipeDelimitedsimplespaceDelimited

verbose_responseboolean

If enabled, the plugin returns more verbose and detailed validation errors.

Default:false

versionstring

Which validator to use. Supported values are kong (default) for using Kong’s own schema validator, or draft4, draft7, draft201909, and draft202012 for using their respective JSON Schema Draft compliant validators.

Allowed values:draft201909draft202012draft4draft6draft7kong

Default:kong

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!