Response Transformer Configuration

You are browsing documentation for an outdated plugin version.

Configuration

This plugin is compatible with DB-less mode.

Compatible protocols

The Response Transformer 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 response-transformer.

  • 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 response-transformer_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
  • remove

    record required
    • json

      array of type string required

      List of property names. Remove the property from the JSON body if it is present.

    • headers

      array of type string required

      List of header names. Unset the header(s) with the given name.

  • rename

    record required
    • headers

      array of type string required

      List of original_header_name:new_header_name pairs. If the header original_headername is already set, rename it to new_headername. Ignored if the header is not already set.

  • replace

    record required
    • json

      array of type string required

      List of property:value pairs. If and only if the parameter is already present, replace its old value with the new one. Ignored if the parameter is not already present.

    • json_types

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

      List of JSON type names. Specify the types of the JSON values returned when replacing JSON properties. Each string element can be one of: boolean, number, or string.

    • headers

      array of type string required

      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.

  • add

    record required
    • json

      array of type string required

      List of property:value pairs. If and only if the property is not present, add a new property with the given value to the JSON body. Ignored if the property is already present.

    • json_types

      array of type string required 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. Each string element can be one of: boolean, number, or string.

    • headers

      array of type string required

      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.

  • append

    record required
    • json

      array of type string required

      List of property:value pairs. If the property is not present in the JSON body, add it with the given value. If it is already present, the two values (old and new) will be aggregated in an array.

    • json_types

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

      List of JSON type names. Specify the types of the JSON values returned when appending JSON properties. Each string element can be one of: boolean, number, or string.

    • headers

      array of type string required

      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. Each string element can be one of: boolean, number, or string.