---
title: "Get a RateLimiting plugin"
method: GET
path: "/plugins/{PluginId}#RateLimiting"
tags: ["Plugins"]
---

# Get a RateLimiting plugin

`GET /plugins/{PluginId}#RateLimiting`

Get a RateLimiting plugin

## Response `200`

RateLimiting plugin

- RateLimitingPlugin
  - `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/).
    - `day` number — The number of HTTP requests that can be made per day.
    - `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.
    - `fault_tolerant` boolean — 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. If `false`, then the clients will see `500` errors.
    - `header_name` string — A string representing an HTTP header name.
    - `hide_client_headers` boolean — Optionally hide informative response headers.
    - `hour` number — The number of HTTP requests that can be made per hour.
    - `limit_by` 'consumer' | 'credential' | 'ip' | 'service' | 'header' | 'path' | 'consumer-group' — The entity that is used when aggregating the limits.
    - `minute` number — The number of HTTP requests that can be made per minute.
    - `month` number — The number of HTTP requests that can be made per month.
    - `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).
    - `policy` 'local' | 'cluster' | 'redis' — The rate-limiting policies to use for retrieving and incrementing the limits.
    - `redis` object — Redis configuration
      - `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.
      - `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.
      - `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.
      - `timeout` integer — An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
      - `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`.
    - `second` number — The number of HTTP requests that can be made per second.
    - `sync_rate` number — How often to sync counter data to the central data store. A value of -1 results in synchronous behavior.
    - `year` number — The number of HTTP requests that can be made per year.
  - `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' — 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
- `404` — Resource does not exist

## Changes

> 3 revisions in range; 1 not diffed.

- **2024-09-11** `5bd52189d290` — 2 info
  - added the optional property `allOf[#/components/schemas/Plugin]/allOf[#/components/schemas/PluginWithoutParents]/ordering/after` to the response with the `200` status
  - added the optional property `allOf[#/components/schemas/Plugin]/allOf[#/components/schemas/PluginWithoutParents]/ordering/before` to the response with the `200` status

[Change history](https://skmtc.dev/kong/apis/kong-enterprise-admin-api/changes/plugins/:PluginId#RateLimiting/get.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)