Configuration
This plugin is compatible with DB-less mode.
Compatible protocols
The JSON Threat Protection 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
json-threat-protection
.- 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
An optional custom name to identify an instance of the plugin, for example
json-threat-protection_my-service
.The instance name shows up in Kong Manager and in Konnect, so it's useful when running the same plugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance via the Kong Admin API.
An instance name must be unique within the following context:
- Within a workspace for Kong Gateway Enterprise
- Within a control plane or control plane group for Konnect
- Globally for Kong Gateway (OSS)
-
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
. -
boolean default:
true
Whether this plugin will be applied.
-
record required
-
integer default:
8192
between:-1
2147483648
Max size of the request body. -1 means unlimited.
-
integer default:
-1
between:-1
2147483648
Max nested depth of objects and arrays. -1 means unlimited.
-
integer default:
-1
between:-1
2147483648
Max number of entries in an object. -1 means unlimited.
-
integer default:
-1
between:-1
2147483648
Max string length of object name. -1 means unlimited.
-
integer default:
-1
between:-1
2147483648
Max number of elements in an array. -1 means unlimited.
-
integer default:
-1
between:-1
2147483648
Max string value length. -1 means unlimited.
-
string default:
block
Must be one of:block
,log_only
Enforcement mode of the security policy.
-
integer default:
400
between:400
499
The response status code when validation fails.
-
string default:
Bad Request
The response message when validation fails
-