Response Transformer Advanced

Overview Examples Configuration reference Changelog

Configuration

configobject

Hide Child Parameters

addobject

Hide Child Parameters

headersarray[string]

Default:[]

if_statusarray[string]

Default:[]

jsonarray[string]

Default:[]

json_typesarray[string]

Allowed values:booleannumberstring

Default:[]

allowobject

Hide Child Parameters

jsonarray[string]

appendobject

Hide Child Parameters

headersarray[string]

Default:[]

if_statusarray[string]

Default:[]

jsonarray[string]

Default:[]

json_typesarray[string]

Allowed values:booleannumberstring

Default:[]

dots_in_keysboolean

Whether dots (for example, customers.info.phone) should be treated as part of a property name or used to descend into nested JSON objects…

Default:true

removeobject

Hide Child Parameters

headersarray[string]

Default:[]

if_statusarray[string]

Default:[]

jsonarray[string]

Default:[]

renameobject

Hide Child Parameters

headersarray[string]

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

Default:[]

if_statusarray[string]

Default:[]

replaceobject

Hide Child Parameters

bodystring

String with which to replace the entire response body.

headersarray[string]

Default:[]

if_statusarray[string]

Default:[]

jsonarray[string]

Default:[]

json_typesarray[string]

Allowed values:booleannumberstring

Default:[]

transformobject

Hide Child Parameters

functionsarray[string]

Default:[]

if_statusarray[string]

Default:[]

jsonarray[string]

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 Advanced

Configuration

Did this doc help?

Help us make these docs great!

Still need help