Response Rate Limiting Configuration

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:

• name or plugin

  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.

• 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.

• consumer.name or consumer.id

  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.

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • header_name

    string default: x-kong-limit

    The name of the response header used to increment the counters.

  • limit_by

    string default: consumer Must be one of: consumer, credential, ip

    The entity that will be used when aggregating the limits: consumer, credential, ip. If the consumer or the credential cannot be determined, the system will always fallback to ip.

  • policy

    string default: cluster 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 datastore 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 of redis or local; for hybrid mode, use redis, or local for data planes only.

    For details on which policy should be used, refer to the implementation considerations.

  • fault_tolerant

    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. If false, then the clients will see 500 errors.

  • redis_host

    string

    When using the redis policy, this property specifies the address to the Redis server.

  • redis_port

    integer default: 6379 between: 0 65535

    When using the redis policy, this property specifies the port of the Redis server.

  • redis_password

    string referenceable len_min: 0

    When using the redis policy, this property specifies the password to connect to the Redis server.

  • redis_username

    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.

  • redis_timeout

    number default: 2000

    When using the redis policy, this property specifies the timeout in milliseconds of any command submitted to the Redis server.

  • redis_database

    number default: 0

    When using the redis policy, this property specifies Redis database to use.

  • block_on_first_violation

    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.

  • hide_client_headers

    boolean required default: false

    Optionally hide informative response headers.

  • limits

    map required len_min: 1