---
title: "Update a RateLimitingAdvanced plugin"
method: PUT
path: "/plugins/{PluginId}#RateLimitingAdvanced"
tags: ["Plugins"]
---

# Update a RateLimitingAdvanced plugin

`PUT /plugins/{PluginId}#RateLimitingAdvanced`

Update a RateLimitingAdvanced plugin

## Request body

- CreateRateLimitingAdvancedPlugin
  - `config` object — The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/).
    - `consumer_groups` string[] — List of consumer groups allowed to override the rate limiting settings for the given Route or Service. Required if `enforce_consumer_groups` is set to `true`.
    - `dictionary_name` string — The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is `config.strategy` is `cluster` or `redis` and `config.sync_rate` isn't `-1`), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle.
    - `disable_penalty` boolean — If set to `true`, this doesn't count denied requests (status = `429`). If set to `false`, all requests, including denied ones, are counted. This parameter only affects the `sliding` window_type.
    - `enforce_consumer_groups` boolean — Determines if consumer groups are allowed to override the rate limiting settings for the given Route or Service. Flipping `enforce_consumer_groups` from `true` to `false` disables the group override, but does not clear the list of consumer groups. You can then flip `enforce_consumer_groups` to `true` to re-enforce the groups.
    - `error_code` number — Set a custom error code to return when the rate limit is exceeded.
    - `error_message` string — Set a custom error message to return when the rate limit is exceeded.
    - `header_name` string — A string representing an HTTP header name.
    - `hide_client_headers` boolean — Optionally hide informative response headers that would otherwise provide information about the current status of limits and counters.
    - `identifier` 'ip' | 'credential' | 'consumer' | 'service' | 'header' | 'path' | 'consumer-group' — The type of identifier used to generate the rate limit key. Defines the scope used to increment the rate limiting counters. Can be `ip`, `credential`, `consumer`, `service`, `header`, `path` or `consumer-group`.
    - `limit` number[] — One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.
    - `namespace` string — The rate limiting library namespace to use for this plugin instance. Counter data and sync configuration is isolated in each namespace. NOTE: For the plugin instances sharing the same namespace, all the configurations that are required for synchronizing counters, e.g. `strategy`, `redis`, `sync_rate`, `window_size`, `dictionary_name`, need to be the same.
    - `path` string — A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
    - `redis` object
      - `cluster_max_redirections` integer — Maximum retry attempts for redirection.
      - `cluster_nodes` object[] — Cluster addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
        - `ip` string — A string representing a host name, such as example.com.
        - `port` integer — An integer representing a port number between 0 and 65535, inclusive.
      - `connect_timeout` integer — An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
      - `connection_is_proxied` boolean — If the connection to Redis is proxied (e.g. Envoy), set it `true`. Set the `host` and `port` to point to the proxy address.
      - `database` integer — Database to use for the Redis connection when using the `redis` strategy
      - `host` string — A string representing a host name, such as example.com.
      - `keepalive_backlog` integer — Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return `nil`. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than `keepalive_pool_size`. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than `keepalive_pool_size`.
      - `keepalive_pool_size` integer — The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither `keepalive_pool_size` nor `keepalive_backlog` is specified, no pool is created. If `keepalive_pool_size` isn't specified but `keepalive_backlog` is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.
      - `password` string — Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
      - `port` integer — An integer representing a port number between 0 and 65535, inclusive.
      - `read_timeout` integer — An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
      - `send_timeout` integer — An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
      - `sentinel_master` string — Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
      - `sentinel_nodes` object[] — Sentinel node addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
        - `host` string — A string representing a host name, such as example.com.
        - `port` integer — An integer representing a port number between 0 and 65535, inclusive.
      - `sentinel_password` string — Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
      - `sentinel_role` 'master' | 'slave' | 'any' — Sentinel role to use for Redis connections when the `redis` strategy is defined. Defining this value implies using Redis Sentinel.
      - `sentinel_username` string — Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
      - `server_name` string — A string representing an SNI (server name indication) value for TLS.
      - `ssl` boolean — If set to true, uses SSL to connect to Redis.
      - `ssl_verify` boolean — If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.
      - `username` string — Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.
    - `retry_after_jitter_max` number — The upper bound of a jitter (random delay) in seconds to be added to the `Retry-After` header of denied requests (status = `429`) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is `0`; in this case, the `Retry-After` header is equal to the `RateLimit-Reset` header.
    - `strategy` 'cluster' | 'redis' | 'local' — The rate-limiting strategy to use for retrieving and incrementing the limits. Available values are: `local` and `cluster`.
    - `sync_rate` number — How often to sync counter data to the central data store. A value of 0 results in synchronous behavior; a value of -1 ignores sync behavior entirely and only stores counters in node memory. A value greater than 0 will sync the counters in the specified number of seconds. The minimum allowed interval is 0.02 seconds (20ms).
    - `window_size` number[] — One or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified.
    - `window_type` 'fixed' | 'sliding' — Sets the time window type to either `sliding` (default) or `fixed`. Sliding windows apply the rate limiting logic while taking into account previous hit rates (from the window that immediately precedes the current) using a dynamic weight. Fixed windows consist of buckets that are statically assigned to a definitive time range, each request is mapped to only one fixed window based on its timestamp and will affect only that window's counters.
  - `created_at` integer — Unix epoch when the resource was created.
  - `enabled` boolean — Whether the plugin is applied.
  - `id` string
  - `instance_name` string
  - `name` 'rate-limiting-advanced' — The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.
  - `ordering` object
    - `after` object
      - `access` string[]
    - `before` object
      - `access` string[]
  - `protocols` string[] — A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support `"tcp"` and `"tls"`.
  - `tags` string[] — An optional set of strings associated with the Plugin for grouping and filtering.
  - `updated_at` integer — Unix epoch when the resource was last updated.
  - `consumer` object — If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
    - `id` string
  - `consumer_group` object
    - `id` string
  - `route` object — If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the Route being used.
    - `id` string
  - `service` object — If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    - `id` string

## Response `200`

RateLimitingAdvanced plugin

- RateLimitingAdvancedPlugin
  - `config` object — The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/).
    - `consumer_groups` string[] — List of consumer groups allowed to override the rate limiting settings for the given Route or Service. Required if `enforce_consumer_groups` is set to `true`.
    - `dictionary_name` string — The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is `config.strategy` is `cluster` or `redis` and `config.sync_rate` isn't `-1`), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle.
    - `disable_penalty` boolean — If set to `true`, this doesn't count denied requests (status = `429`). If set to `false`, all requests, including denied ones, are counted. This parameter only affects the `sliding` window_type.
    - `enforce_consumer_groups` boolean — Determines if consumer groups are allowed to override the rate limiting settings for the given Route or Service. Flipping `enforce_consumer_groups` from `true` to `false` disables the group override, but does not clear the list of consumer groups. You can then flip `enforce_consumer_groups` to `true` to re-enforce the groups.
    - `error_code` number — Set a custom error code to return when the rate limit is exceeded.
    - `error_message` string — Set a custom error message to return when the rate limit is exceeded.
    - `header_name` string — A string representing an HTTP header name.
    - `hide_client_headers` boolean — Optionally hide informative response headers that would otherwise provide information about the current status of limits and counters.
    - `identifier` 'ip' | 'credential' | 'consumer' | 'service' | 'header' | 'path' | 'consumer-group' — The type of identifier used to generate the rate limit key. Defines the scope used to increment the rate limiting counters. Can be `ip`, `credential`, `consumer`, `service`, `header`, `path` or `consumer-group`.
    - `limit` number[] — One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.
    - `namespace` string — The rate limiting library namespace to use for this plugin instance. Counter data and sync configuration is isolated in each namespace. NOTE: For the plugin instances sharing the same namespace, all the configurations that are required for synchronizing counters, e.g. `strategy`, `redis`, `sync_rate`, `window_size`, `dictionary_name`, need to be the same.
    - `path` string — A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
    - `redis` object
      - `cluster_max_redirections` integer — Maximum retry attempts for redirection.
      - `cluster_nodes` object[] — Cluster addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
        - `ip` string — A string representing a host name, such as example.com.
        - `port` integer — An integer representing a port number between 0 and 65535, inclusive.
      - `connect_timeout` integer — An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
      - `connection_is_proxied` boolean — If the connection to Redis is proxied (e.g. Envoy), set it `true`. Set the `host` and `port` to point to the proxy address.
      - `database` integer — Database to use for the Redis connection when using the `redis` strategy
      - `host` string — A string representing a host name, such as example.com.
      - `keepalive_backlog` integer — Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return `nil`. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than `keepalive_pool_size`. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than `keepalive_pool_size`.
      - `keepalive_pool_size` integer — The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither `keepalive_pool_size` nor `keepalive_backlog` is specified, no pool is created. If `keepalive_pool_size` isn't specified but `keepalive_backlog` is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.
      - `password` string — Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
      - `port` integer — An integer representing a port number between 0 and 65535, inclusive.
      - `read_timeout` integer — An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
      - `send_timeout` integer — An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
      - `sentinel_master` string — Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
      - `sentinel_nodes` object[] — Sentinel node addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
        - `host` string — A string representing a host name, such as example.com.
        - `port` integer — An integer representing a port number between 0 and 65535, inclusive.
      - `sentinel_password` string — Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
      - `sentinel_role` 'master' | 'slave' | 'any' — Sentinel role to use for Redis connections when the `redis` strategy is defined. Defining this value implies using Redis Sentinel.
      - `sentinel_username` string — Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
      - `server_name` string — A string representing an SNI (server name indication) value for TLS.
      - `ssl` boolean — If set to true, uses SSL to connect to Redis.
      - `ssl_verify` boolean — If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.
      - `username` string — Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.
    - `retry_after_jitter_max` number — The upper bound of a jitter (random delay) in seconds to be added to the `Retry-After` header of denied requests (status = `429`) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is `0`; in this case, the `Retry-After` header is equal to the `RateLimit-Reset` header.
    - `strategy` 'cluster' | 'redis' | 'local' — The rate-limiting strategy to use for retrieving and incrementing the limits. Available values are: `local` and `cluster`.
    - `sync_rate` number — How often to sync counter data to the central data store. A value of 0 results in synchronous behavior; a value of -1 ignores sync behavior entirely and only stores counters in node memory. A value greater than 0 will sync the counters in the specified number of seconds. The minimum allowed interval is 0.02 seconds (20ms).
    - `window_size` number[] — One or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified.
    - `window_type` 'fixed' | 'sliding' — Sets the time window type to either `sliding` (default) or `fixed`. Sliding windows apply the rate limiting logic while taking into account previous hit rates (from the window that immediately precedes the current) using a dynamic weight. Fixed windows consist of buckets that are statically assigned to a definitive time range, each request is mapped to only one fixed window based on its timestamp and will affect only that window's counters.
  - `created_at` integer — Unix epoch when the resource was created.
  - `enabled` boolean — Whether the plugin is applied.
  - `id` string
  - `instance_name` string
  - `name` 'rate-limiting-advanced' — The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.
  - `ordering` object
    - `after` object
      - `access` string[]
    - `before` object
      - `access` string[]
  - `protocols` string[] — A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support `"tcp"` and `"tls"`.
  - `tags` string[] — An optional set of strings associated with the Plugin for grouping and filtering.
  - `updated_at` integer — Unix epoch when the resource was last updated.
  - `consumer` object — If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
    - `id` string
  - `consumer_group` object
    - `id` string
  - `route` object — If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the Route being used.
    - `id` string
  - `service` object — If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    - `id` string

## Other responses

- `401` — Unauthorized

## Changes

> 3 revisions in range; 1 not diffed.

- **2024-09-11** `5bd52189d290` — 6 warning, 22 info
  - removed the request property `allOf[#/components/schemas/RateLimitingAdvancedPluginConfig]/config/redis/cluster_addresses`
  - removed the request property `allOf[#/components/schemas/RateLimitingAdvancedPluginConfig]/config/redis/sentinel_addresses`
  - removed the request property `allOf[#/components/schemas/RateLimitingAdvancedPluginConfig]/config/redis/timeout`
  - removed the optional property `allOf[#/components/schemas/RateLimitingAdvancedPluginConfig]/config/redis/cluster_addresses` from the response with the `200` status
  - …24 more

[Change history](https://skmtc.dev/kong/apis/kong-enterprise-admin-api/changes/plugins/:PluginId#RateLimitingAdvanced/put.md)

---

[API](https://skmtc.dev/kong/apis/kong-enterprise-admin-api.md) · [All operations](https://skmtc.dev/kong/apis/kong-enterprise-admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/kong/kong-enterprise-admin-api/revisions/5bd52189d290/schema)