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:
-
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
.
- If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is
-
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)
-
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
. -
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
. -
boolean default:
true
Whether this plugin will be applied.
-
record required
-
array of type
string
requiredArray of stringified Lua code to be cached and run in sequence during the certificate phase.
Note: This only runs on global plugins.
-
array of type
string
requiredArray of stringified Lua code to be cached and run in sequence during the rewrite phase.
Note: This only runs on global plugins.
-
array of type
string
requiredArray of stringified Lua code to be cached and run in sequence during the access phase.
-
array of type
string
requiredArray of stringified Lua code to be cached and run in sequence during the header_filter phase.
-
array of type
string
requiredArray of stringified Lua code to be cached and run in sequence during the body_filter phase.
-
array of type
string
requiredArray of stringified Lua code to be cached and run in sequence during the log phase.
-
array of type
string
required
-
array of type
string
required
-
array of type
string
required
-
array of type
string
required
-