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:
-
name
string requiredThe name of the plugin, in this case
jq
. -
instance_name
stringAn optional custom name to identify an instance of the plugin, for example
jq_my-service
. Useful when running the same plugin in multiple contexts, for example, on multiple services. -
service.name or service.id
stringThe 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/SERVICE_NAME|ID/plugins
. -
route.name or route.id
stringThe 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/ROUTE_NAME|ID/plugins
. -
consumer.name or consumer.id
stringThe 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/CONSUMER_NAME|ID/plugins
. -
enabled
boolean default:true
Whether this plugin will be applied.
-
config
record required-
request_jq_program
string
-
request_jq_program_options
record-
compact_output
boolean required default:true
-
raw_output
boolean required default:false
-
join_output
boolean required default:false
-
ascii_output
boolean required default:false
-
sort_keys
boolean required default:false
-
-
request_if_media_type
array of typestring
default:application/json
-
response_jq_program
string
-
response_jq_program_options
record-
compact_output
boolean required default:true
-
raw_output
boolean required default:false
-
join_output
boolean required default:false
-
ascii_output
boolean required default:false
-
sort_keys
boolean required default:false
-
-
response_if_media_type
array of typestring
default:application/json
-
response_if_status_code
array of typeinteger
default:200
-