Response Transformer

Overview Examples Configuration reference Changelog

Configuration

configobject

Hide Child Parameters

addobject

Hide Child Parameters

headersarray[string]

Match pattern:^[^:]+:.*$

Default:[]

jsonarray[string]

Match pattern:^[^:]+:.*$

Default:[]

json_typesarray[string]

List of JSON type names. Specify the types of the JSON values returned when appending
JSON properties. Each string element can be one of: boolean, number, or string.

Allowed values:booleannumberstring

Default:[]

appendobject

Hide Child Parameters

headersarray[string]

Match pattern:^[^:]+:.*$

Default:[]

jsonarray[string]

Match pattern:^[^:]+:.*$

Default:[]

json_typesarray[string]

List of JSON type names. Specify the types of the JSON values returned when appending
JSON properties. Each string element can be one of: boolean, number, or string.

Allowed values:booleannumberstring

Default:[]

removeobject

Hide Child Parameters

headersarray[string]

Default:[]

jsonarray[string]

Default:[]

renameobject

Hide Child Parameters

headersarray[string]

Match pattern:^[^:]+:.*$

Default:[]

jsonarray[string]

Match pattern:^[^:]+:.*$

Default:[]

replaceobject

Hide Child Parameters

headersarray[string]

Match pattern:^[^:]+:.*$

Default:[]

jsonarray[string]

Match pattern:^[^:]+:.*$

Default:[]

json_typesarray[string]

List of JSON type names. Specify the types of the JSON values returned when appending
JSON properties. Each string element can be one of: boolean, number, or string.

Allowed values:booleannumberstring

Default:[]

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

consumer_groupobject

If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups

* 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

Response Transformer

Configuration

Did this doc help?

Help us make these docs great!

Still need help