Request Transformer Advanced Configuration

You are browsing unreleased documentation.

Configuration

This plugin is compatible with DB-less mode.

Compatible protocols

The Request Transformer Advanced 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 or plugin

  string required

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

  • If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is name.
  • If using the KongPlugin object in Kubernetes, the field is plugin.

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example request-transformer-advanced_my-service.

  The instance name shows up in Kong Manager and in Konnect, so it's useful when running the same plugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance via the Kong Admin API.

  An instance name must be unique within the following context:

  • Within a workspace for Kong Gateway Enterprise
  • Within a control plane or control plane group for Konnect
  • Globally for Kong Gateway (OSS)

• 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/{serviceName|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/{routeName|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/{consumerName|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/{consumerGroupName|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

    • headers

      array of type string

    • querystring

      array of type string

  • rename

    record required
    • body

      array of type string referenceable

    • headers

      array of type string referenceable

    • querystring

      array of type string referenceable

  • replace

    record required
    • body

      array of type string referenceable

    • headers

      array of type string referenceable

    • querystring

      array of type string referenceable

    • json_types

      array of type string Must be one of: boolean, number, string

    • uri

      string

  • add

    record required
    • body

      array of type string referenceable

    • headers

      array of type string referenceable

    • querystring

      array of type string referenceable

    • json_types

      array of type string Must be one of: boolean, number, string

  • append

    record required
    • body

      array of type string referenceable

    • headers

      array of type string referenceable

    • querystring

      array of type string referenceable

    • json_types

      array of type string Must be one of: boolean, number, string

  • allow

    record required
    • body

      set of type string

  • dots_in_keys

    boolean default: true

    Specify whether dots (for example, customers.info.phone) should be treated as part of a property name or used to descend into nested JSON objects. See Arrays and nested objects.