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.

Compatible protocols

The Kong Functions (Pre-Plugins) plugin is compatible with the following protocols:

grpc, grpcs, http, https, ws, wss

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.

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example pre-function_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.

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • certificate

    array of type string required

    Custom functions, which can be user-defined, are cached and executed sequentially during specific phases: certificate, rewrite, access, header_filter, body_filter, and log.

  • rewrite

    array of type string required

    Custom functions, which can be user-defined, are cached and executed sequentially during specific phases: certificate, rewrite, access, header_filter, body_filter, and log.

  • access

    array of type string required

    Custom functions, which can be user-defined, are cached and executed sequentially during specific phases: certificate, rewrite, access, header_filter, body_filter, and log.

  • header_filter

    array of type string required

    Custom functions, which can be user-defined, are cached and executed sequentially during specific phases: certificate, rewrite, access, header_filter, body_filter, and log.

  • body_filter

    array of type string required

    Custom functions, which can be user-defined, are cached and executed sequentially during specific phases: certificate, rewrite, access, header_filter, body_filter, and log.

  • log

    array of type string required

    Custom functions, which can be user-defined, are cached and executed sequentially during specific phases: certificate, rewrite, access, header_filter, body_filter, and log.

  • ws_handshake

    array of type string required

    Custom functions, which can be user-defined, are cached and executed sequentially during specific phases: certificate, rewrite, access, header_filter, body_filter, and log.

  • ws_client_frame

    array of type string required

    Custom functions, which can be user-defined, are cached and executed sequentially during specific phases: certificate, rewrite, access, header_filter, body_filter, and log.

  • ws_upstream_frame

    array of type string required

    Custom functions, which can be user-defined, are cached and executed sequentially during specific phases: certificate, rewrite, access, header_filter, body_filter, and log.

  • ws_close

    array of type string required

    Custom functions, which can be user-defined, are cached and executed sequentially during specific phases: certificate, rewrite, access, header_filter, body_filter, and log.