Protects a Service or a Route from most common bots and has the capability of allowing and denying custom clients.
You can configure this plugin using the
Kong Admin API
or through declarative configuration, which involves directly editing
the Kong configuration file.
This plugin is compatible with requests with the following protocols:
This plugin is compatible with DB-less mode.
In DB-less mode, Kong does not have an Admin API. If using this
mode, configure the plugin using declarative configuration.
Enabling the plugin on a Service
<service> is the
name of the Service that this plugin
configuration will target.
Enabling the plugin on a Route
<route> is the
name of the Route that this plugin configuration
Enabling the plugin globally
A plugin which is not associated to any Service, Route, or Consumer is
considered global, and will be run on every request. Read the
Plugin Reference and the Plugin Precedence
sections for more information.
Here's a list of all the parameters which can be used in this plugin's configuration:
|The name of the plugin to use, in this case |
|The ID of the Service the plugin targets.|
|The ID of the Route the plugin targets.|
|Whether this plugin will be applied.|
An array of regular expressions that should be allowed. The regular expressions will be checked against the
An array of regular expressions that should be denied. The regular expressions will be checked against the
The plugin already includes a basic list of rules that will be checked on every request. You can find this list on GitHub at https://github.com/Kong/kong/blob/master/kong/plugins/bot-detection/rules.lua.