Request Transformer

Overview Examples Configuration reference Changelog

Configuration

configobject

Hide Child Parameters

addobject

Hide Child Parameters

bodyarray[string]

Default:[]

headersarray[string]

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

Default:[]

querystringarray[string]

Default:[]

appendobject

Hide Child Parameters

bodyarray[string]

Default:[]

headersarray[string]

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

Default:[]

querystringarray[string]

Default:[]

http_methodstring

A string representing an HTTP method, such as GET, POST, PUT, or DELETE. The string must contain only uppercase letters.

Match pattern:^[A-Z]+$

removeobject

Hide Child Parameters

bodyarray[string]

Default:[]

headersarray[string]

Default:[]

querystringarray[string]

Default:[]

renameobject

Hide Child Parameters

bodyarray[string]

Default:[]

headersarray[string]

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

Default:[]

querystringarray[string]

Default:[]

replaceobject

Hide Child Parameters

bodyarray[string]

Default:[]

headersarray[string]

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

Default:[]

querystringarray[string]

Default:[]

uristring

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 string representing a protocol, such as HTTP or HTTPS.

Allowed values:grpcgrpcshttphttpstcptlstls_passthroughudpwswss

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

Request Transformer

Configuration

Did this doc help?

Help us make these docs great!

Still need help