Route Transformer Advanced Configuration

Configuration

This plugin is compatible with DB-less mode.

Compatible protocols

The Route 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

  string required

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

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example route-transformer-advanced_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|SERVICE_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|ROUTE_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|CONSUMER_ID/plugins.

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • path

    string

    Updates the upstream request path with given value/template. This value can only be used to update the path part of the URI, not the scheme, nor the hostname. One of config.path or config.host or config.port must be specified.

  • port

    string

    Updates the upstream request Port with given value/template. Note that the port as set may be overridden again by DNS resolution (in case of SRV records,or an Upstream) One of config.path or config.host or config.port must be specified.

  • host

    string

    Updates the upstream request Host with given value/template. This value can only be used to update the routing, it will not update the Host-header value. One of config.path or config.host or config.port must be specified.

  • escape_path

    boolean default: false

    If set to true, the path is escaped after being transformed.