You are browsing documentation for an outdated plugin version.
Configuration
This plugin is partially compatible with DB-less mode.
The plugin will run fine with the local
policy (which doesn’t use the database) or
the redis
policy (which uses an independent Redis, so it is compatible with DB-less).
The plugin will not work with the cluster
policy, which requires writes to the database.
Compatible protocols
The Rate Limiting 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:
-
string required
The name of the plugin, in this case
rate-limiting
.- 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
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
. -
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/{consumerName|Id}/plugins
. -
boolean default:
true
Whether this plugin will be applied.
-
record required
-
number
The number of HTTP requests that can be made per second.
-
number
The number of HTTP requests that can be made per minute.
-
number
The number of HTTP requests that can be made per hour.
-
number
The number of HTTP requests that can be made per day.
-
number
The number of HTTP requests that can be made per month.
-
number
The number of HTTP requests that can be made per year.
-
string default:
consumer
Must be one of:consumer
,credential
,ip
,service
,header
,path
The entity that is used when aggregating the limits. Available values are:
consumer
credential
ip
service
-
header
(Theheader_name
configuration must be provided.) -
path
(Thepath
configuration must be provided.)
If the entity value for aggregating the limits cannot be determined, the system falls back to
ip
.
-
string
Header name to be used if
limit_by
is set toheader
.
-
string starts_with:
/
Path to be used if
limit_by
is set topath
.
-
string default:
cluster
len_min:0
Must be one of:local
,cluster
,redis
The rate-limiting policies to use for retrieving and incrementing the limits. Available values are:
-
local
: Counters are stored locally in-memory on the node. -
cluster
: Counters are stored in the Kong data store and shared across the nodes. -
redis
: Counters are stored on a Redis server and shared across the nodes.
In DB-less, hybrid mode, and Konnect, the
cluster
config policy is not supported. For DB-less mode or Konnect, use one ofredis
orlocal
; for hybrid mode, useredis
, orlocal
for data planes only.For details on which policy should be used, refer to the implementation considerations.
-
-
boolean required default:
true
A boolean value that determines if the requests should be proxied even if Kong has troubles connecting a third-party data store. If
true
, requests will be proxied anyway, effectively disabling the rate-limiting function until the data store is working again. Iffalse
, then the clients will see500
errors.
-
string
When using the
redis
policy, this property specifies the address to the Redis server.
-
integer default:
6379
between:0
65535
When using the
redis
policy, this property specifies the port of the Redis server. By default is6379
.
-
string referenceable len_min:
0
When using the
redis
policy, this property specifies the password to connect to the Redis server.
-
string referenceable
When using the
redis
policy, this property specifies the username to connect to the Redis server when ACL authentication is desired.This requires Redis v6.0.0+. The username cannot be set to
default
.
-
boolean required default:
false
When using the
redis
policy, this property specifies if SSL is used to connect to the Redis server.
-
boolean required default:
false
When using the
redis
policy withredis_ssl
set totrue
, this property specifies it server SSL certificate is validated. Note that you need to configure the lua_ssl_trusted_certificate to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
-
string
When using the
redis
policy withredis_ssl
set totrue
, this property specifies the server name for the TLS extension Server Name Indication (SNI)
-
number default:
2000
When using the
redis
policy, this property specifies the timeout in milliseconds of any command submitted to the Redis server.
-
integer default:
0
When using the
redis
policy, this property specifies the Redis database to use.
-
boolean required default:
false
Optionally hide informative response headers.
-