Plugins

Get a RateLimiting plugin

get/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#RateLimiting

Response

RateLimiting plugin

conditionstring nullable

An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.

created_atinteger nullable

Unix epoch when the resource was created.

enabledboolean nullable

Whether the plugin is applied.

idstring nullable

A string representing a UUID (universally unique identifier).

instance_namestring nullable

A unique string representing a UTF-8 encoded name.

name'rate-limiting' required

The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.

tagsstring[] nullable

An optional set of strings associated with the Plugin for grouping and filtering.

updated_atinteger nullable

Unix epoch when the resource was last updated.

protocolsstring[]

A set of strings representing HTTP protocols.

Changes

Changed in 14 of the 52 revisions of this API.2644

Jun 26, 20264a39c7f8550911See the full diff
- ▲
  the allOf[RateLimitingPluginConfig]/config/redis/port response's property type/format changed from integer/ to string/ for status 200
  response-property-type-changed
- ○
  the port response's property default value changed from 6379 to 6379 for the status 200
  response-property-default-value-changed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 11, 202662c54f1094bb1See the full diff
- ○
  the response property allOf[PluginBase]/partials/items/path became required for the status 200
  response-property-became-required
Apr 24, 20267d6a643707d91See the full diff
- ○
  added the optional property allOf[PluginBase]/condition to the response with the 200 status
  response-optional-property-added
Jan 13, 2026ad02b4e24eb21See the full diff
- ○
  added the optional property allOf[RateLimitingPluginConfig]/config/redis/cloud_authentication to the response with the 200 status
  response-optional-property-added
Oct 29, 202519e869275e281See the full diff
- ▲
  the allOf[RateLimitingPluginConfig]/name response's property type/format changed from string/ to / for status 200
  response-property-type-changed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 22, 202596118a9cd7f41514See the full diff
- ▲
  the response property allOf[PluginBase]/partials/items/name became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[PluginBase]/partials/items/path became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[RateLimitingPluginConfig]/config became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[RateLimitingPluginConfig]/config/day became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[RateLimitingPluginConfig]/config/header_name became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[RateLimitingPluginConfig]/config/hour became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[RateLimitingPluginConfig]/config/minute became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[RateLimitingPluginConfig]/config/month became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[RateLimitingPluginConfig]/config/path became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[RateLimitingPluginConfig]/config/redis/host became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[RateLimitingPluginConfig]/config/redis/password became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[RateLimitingPluginConfig]/config/redis/server_name became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[RateLimitingPluginConfig]/config/redis/username became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[RateLimitingPluginConfig]/config/second became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[RateLimitingPluginConfig]/config/year became nullable for the status 200
  response-property-became-nullable
- ○
  the database response's property default value 0 was added for the status 200
  response-property-default-value-added
- ○
  the enabled response's property default value true was added for the status 200
  response-property-default-value-added
- ○
  the error_code response's property default value 429 was added for the status 200
  response-property-default-value-added
- ○
  the error_message response's property default value API rate limit exceeded was added for the status 200
  response-property-default-value-added
- ○
  the fault_tolerant response's property default value true was added for the status 200
  response-property-default-value-added
- ○
  the hide_client_headers response's property default value false was added for the status 200
  response-property-default-value-added
- ○
  the limit_by response's property default value consumer was added for the status 200
  response-property-default-value-added
- ○
  the policy response's property default value local was added for the status 200
  response-property-default-value-added
- ○
  the port response's property default value 6379 was added for the status 200
  response-property-default-value-added
- ○
  the protocols response's property default value grpc grpcs http https was added for the status 200
  response-property-default-value-added
- ○
  the ssl response's property default value false was added for the status 200
  response-property-default-value-added
- ○
  the ssl_verify response's property default value false was added for the status 200
  response-property-default-value-added
- ○
  the sync_rate response's property default value -1 was added for the status 200
  response-property-default-value-added
- ○
  the timeout response's property default value 2000 was added for the status 200
  response-property-default-value-added
This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 22, 20252c77aeaee5fb1See the full diff
- ▲
  the response property allOf[PluginBase]/tags became nullable for the status 200
  response-property-became-nullable
Jun 17, 2025c308b7426a7c1See the full diff
- ▲
  the allOf[RateLimitingPluginConfig]/protocols response's property type/format changed from array/ to array/set for status 200
  response-property-type-changed
May 21, 202569704304ad5f1See the full diff
- ○
  added the optional property allOf[PluginBase]/partials to the response with the 200 status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 15, 2025fc6abbc537f322See the full diff
- ▲
  the response property allOf[PluginBase]/created_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[PluginBase]/updated_at became nullable for the status 200
  response-property-became-nullable
- ○
  the response optional property allOf[PluginBase]/created_at became not read-only for the status 200
  response-optional-property-became-not-read-only
- ○
  the response optional property allOf[PluginBase]/updated_at became not read-only for the status 200
  response-optional-property-became-not-read-only
This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history (14 revisions)