Request Transformer Configuration

Configuration

This plugin is compatible with DB-less mode.

Compatible protocols

The Request Transformer plugin is compatible with the following protocols:

grpc, grpcs, http, https, tcp, tls, tls_passthrough, udp, ws, wss

Parameters

Here's a list of all the parameters which can be used in this plugin's configuration:

• name

  string required

  The name of the plugin, in this case request-transformer.

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example request-transformer_my-service. Useful when running the same plugin in multiple contexts, for example, on multiple services.

• service.name or service.id

  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/SERVICE_NAME|ID/plugins.

• route.name or route.id

  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/ROUTE_NAME|ID/plugins.

• consumer.name or consumer.id

  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/CONSUMER_NAME|ID/plugins.

• consumer_group.name or consumer_group.id

  string

  The name or ID of the consumer group the plugin targets. If set, the plugin will activate only for requests where the specified group has been authenticated /plugins endpoint. Not required if using /consumer_groups/{CONSUMER_GROUP_NAME|ID}/plugins.

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • http_method

    string matches: ^%u+$

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

  • remove

    record required
    • body

      array of type string required

    • headers

      array of type string required

    • querystring

      array of type string required

  • rename

    record required
    • body

      array of type string required

    • headers

      array of type string required

    • querystring

      array of type string required

  • replace

    record required
    • body

      array of type string required

    • headers

      array of type string required

    • querystring

      array of type string required

    • uri

      string

  • add

    record required
    • body

      array of type string required

    • headers

      array of type string required

    • querystring

      array of type string required

  • append

    record required
    • body

      array of type string required

    • headers

      array of type string required

    • querystring

      array of type string required