You are browsing documentation for an outdated plugin version.
Configuration
Compatible protocols
The jq 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
jq
.- 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
jq_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
. -
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
The jq program to run on the request body. For example,
.[0] | { "X-Foo": .foo }
. Eitherrequest_jq_program
orresponse_jq_plugin
must be included in the configuration.
-
record
Boolean option flags to modify the run behavior of the jq program run on the request body.
-
compact_output
: Returns output in a compact form without additional spacing, and with each JSON object on a single line. Defaults totrue
. Set tofalse
for ‘pretty’ output. -
raw_output
: Outputs as raw strings, not JSON quoted. Default isfalse
. -
join_output
: Similar toraw_output
but does not output newline separators. Default isfalse
. -
ascii_output
: jq usually outputs non-ASCII Unicode codepoints as UTF-8, even if the input specified them as escape sequences (likeμ
). Using this option, you can force jq to produce pure ASCII output, replacing every non-ASCII character with the equivalent escape sequence. Default isfalse
. -
sort_keys
: Outputs the fields of each object with the keys in sorted order. Default isfalse
.
-
-
array of type
string
default:application/json
A list of media type strings. The media type included in the
Content-Type
request header must match one of the media types on this list for the program to run.
-
string
The jq program to run on the response body. For example,
.[0] | { "X-Foo": .foo }
. Eitherrequest_jq_program
orresponse_jq_plugin
must be included in configuration.
-
record
Boolean option flags to modify the run behavior of the jq program run on the response body.
-
compact_output
: Returns output in a compact form without additional spacing, and with each JSON object on a single line. Defaults totrue
. Set tofalse
for ‘pretty’ output. -
raw_output
: Outputs as raw strings, not JSON quoted. Default isfalse
. -
join_output
: Similar toraw_output
but does not output newline separators. Default isfalse
. -
ascii_output
: jq usually outputs non-ASCII Unicode codepoints as UTF-8, even if the input specified them as escape sequences (likeμ
). Using this option, you can force jq to produce pure ASCII output, replacing every non-ASCII character with the equivalent escape sequence. Default isfalse
. -
sort_keys
: Outputs the fields of each object with the keys in sorted order. Default isfalse
.
-
-
array of type
string
default:application/json
A list of media type strings. The media type included in the
Content-Type
response header must match one of the media types on this list for the program to run.
-
array of type
integer
default:200
A list of HTTP response status codes. The response status code must match one of the response status codes on this list for the program to run.
-