Request Transformer Advanced Configuration

You are browsing documentation for an outdated plugin version.

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.

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • http_method

    string matches: ^%u+$

    Changes the HTTP method for the upstream request.

  • remove

    record required
    • body

      array of type string

      List of parameter names. Remove the parameter if and only if content-type is one of the following: [application/json, multipart/form-data, application/x-www-form-urlencoded]; and parameter is present.

    • headers

      array of type string

      List of header names. Unset the headers with the given name.

    • querystring

      array of type string

      List of querystring names. Remove the querystring if it is present.

  • rename

    record required
    • body

      array of type string referenceable

      List of parameter name:value pairs. Rename the parameter name if and only if content-type is one of the following: [application/json, multipart/form-data, application/x-www-form-urlencoded]; and parameter is present.

    • headers

      array of type string referenceable

      List of headername:value pairs. If and only if the header is already set, rename the header. The value is unchanged. Ignored if the header is not already set.

    • querystring

      array of type string referenceable

      List of queryname:value pairs. If and only if the field name is already set, rename the field name. The value is unchanged. Ignored if the field name is not already set.

  • replace

    record required
    • body

      array of type string referenceable

      List of paramname:value pairs. If and only if content-type is one the following: [application/json, multipart/form-data, application/x-www-form-urlencoded]; and the parameter is already present, replace its old value with the new one. Ignored if the parameter is not already present.

    • headers

      array of type string referenceable

      List of headername:value pairs. If and only if the header is already set, replace its old value with the new one. Ignored if the header is not already set.

    • querystring

      array of type string referenceable

      List of queryname:value pairs. If and only if the querystring name is already set, replace its old value with the new one. Ignored if the header is not already set.

    • json_types

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

      List of JSON type names. Specify the types of the JSON values returned when replacing JSON properties.

    • uri

      string

      Updates the upstream request URI with given value. This value can only be used to update the path part of the URI; not the scheme, nor the hostname.

  • add

    record required
    • body

      array of type string referenceable

      List of paramname:value pairs. If and only if content-type is one the following: [application/json, multipart/form-data, application/x-www-form-urlencoded]; and the parameter is not present, add a new parameter with the given value to form-encoded body. Ignored if the parameter is already present.

    • headers

      array of type string referenceable

      List of headername:value pairs. If and only if the header is not already set, set a new header with the given value. Ignored if the header is already set.

    • querystring

      array of type string referenceable

      List of queryname:value pairs. If and only if the querystring name is not already set, set a new querystring with the given value. Ignored if the querystring name is already set.

    • json_types

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

      List of JSON type names. Specify the types of the JSON values returned when adding a new JSON property.

  • append

    record required
    • body

      array of type string referenceable

      List of paramname:value pairs. If the content-type is one the following: [application/json, application/x-www-form-urlencoded]; add a new parameter with the given value if the parameter is not present. Otherwise, if it is already present, the two values (old and new) will be aggregated in an array.

    • headers

      array of type string referenceable

      List of headername:value pairs. If the header is not set, set it with the given value. If it is already set, a new header with the same name and the new value will be set.

    • querystring

      array of type string referenceable

      List of queryname:value pairs. If the querystring is not set, set it with the given value. If it is already set, a new querystring with the same name and the new value will be set.

    • json_types

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

      List of JSON type names. Specify the types of the JSON values returned when appending JSON properties.

  • allow

    record required
    • body

      set of type string

      Set of parameter names. If and only if content-type is one the following: [application/json, multipart/form-data, application/x-www-form-urlencoded]; allow only allowed parameters in the body.

  • 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.