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 Response 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
response-ratelimiting
.- 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
response-ratelimiting_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
. -
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
-
string default:
x-kong-limit
The name of the response header used to increment the counters.
-
string default:
consumer
Must be one of:consumer
,credential
,ip
The entity that will be used when aggregating the limits:
consumer
,credential
,ip
. If theconsumer
or thecredential
cannot be determined, the system will always fallback toip
.
-
string default:
local
Must be one of:local
,cluster
,redis
The rate-limiting policies to use for retrieving and incrementing the limits.
-
boolean required default:
true
A boolean value that determines if the requests should be proxied even if Kong has troubles connecting a third-party datastore. If
true
, requests will be proxied anyway, effectively disabling the rate-limiting function until the datastore 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.
-
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 todefault
.
-
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 if the server SSL certificate is validated. Note that you need to configure thelua_ssl_trusted_certificate
to specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_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.
-
number default:
0
When using the
redis
policy, this property specifies Redis database to use.
-
boolean required default:
false
A boolean value that determines if the requests should be blocked as soon as one limit is being exceeded. This will block requests that are supposed to consume other limits too.
-
boolean required default:
false
Optionally hide informative response headers.
-
map required len_min:
1
A map that defines rate limits for the plugin.
-