Kong Functions (Pre-Plugins) Configuration

You are browsing documentation for an outdated plugin version.

Configuration

This plugin is partially compatible with DB-less mode.

The functions will be executed, but if the configured functions attempt to write to the database, the writes will fail.

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 pre-function.

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

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

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • functions

    array of type string required

    Deprecated. Use config.access instead.

    Array of stringified Lua code to be cached and run in sequence during access phase.

  • certificate

    array of type string required

    Array of stringified Lua code to be cached and run in sequence during the certificate phase.

    Note: This only runs on global plugins.

  • rewrite

    array of type string required

    Array of stringified Lua code to be cached and run in sequence during the rewrite phase.

    Note: This only runs on global plugins.

  • access

    array of type string required

    Array of stringified Lua code to be cached and run in sequence during the access phase.

  • header_filter

    array of type string required

    Array of stringified Lua code to be cached and run in sequence during the header_filter phase.

  • body_filter

    array of type string required

    Array of stringified Lua code to be cached and run in sequence during the body_filter phase.

  • log

    array of type string required

    Array of stringified Lua code to be cached and run in sequence during the log phase.