Sign in
Plugins

Create a RateLimiting plugin

Create a RateLimiting plugin

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

Request body

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.

Response

Created 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 17 of the 52 revisions of this API.412102

  • 4a39c7f8550922See the full diff
    • ▲

      the allOf[RateLimitingPluginConfig]/config/redis/port request property type/format changed from integer/ to string/

      request-property-type-changed

    • ▲

      the allOf[RateLimitingPluginConfig]/config/redis/port response's property type/format changed from integer/ to string/ for status 201

      response-property-type-changed

    • ○

      the port request property default value changed from 6379 to 6379

      request-property-default-value-changed

    • ○

      the port response's property default value changed from 6379 to 6379 for the status 201

      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

  • 62c54f1094bb11See the full diff
    • ▲

      the request property allOf[PluginBase]/partials/items/path became required

      request-property-became-required

    • ○

      the response property allOf[PluginBase]/partials/items/path became required for the status 201

      response-property-became-required

  • 7d6a643707d92See the full diff
    • ○

      added the new optional request property allOf[PluginBase]/condition

      new-optional-request-property

    • ○

      added the optional property allOf[PluginBase]/condition to the response with the 201 status

      response-optional-property-added

  • ad02b4e24eb22See the full diff
    • ○

      added the new optional request property allOf[RateLimitingPluginConfig]/config/redis/cloud_authentication

      new-optional-request-property

    • ○

      added the optional property allOf[RateLimitingPluginConfig]/config/redis/cloud_authentication to the response with the 201 status

      response-optional-property-added

  • 19e869275e282See the full diff
    • ▲

      the allOf[RateLimitingPluginConfig]/name request property type/format changed from string/ to /

      request-property-type-changed

    • ▲

      the allOf[RateLimitingPluginConfig]/name response's property type/format changed from string/ to / for status 201

      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

  • f030590166225See the full diff
    • ▲

      the request property allOf[PluginBase]/partials/items/name became not nullable

      request-property-became-not-nullable

    • ▲

      the request property allOf[PluginBase]/partials/items/path became not nullable

      request-property-became-not-nullable

    • ▲

      the allOf[PluginBase]/id request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      the allOf[PluginBase]/name request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      the allOf[PluginBase]/partials/items/id request property's minLength was increased from 0 to 1

      request-property-min-length-increased

  • 96118a9cd7f41543See the full diff
    • ▲

      the response property allOf[PluginBase]/partials/items/name became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[PluginBase]/partials/items/path became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[RateLimitingPluginConfig]/config became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[RateLimitingPluginConfig]/config/day became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[RateLimitingPluginConfig]/config/header_name became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[RateLimitingPluginConfig]/config/hour became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[RateLimitingPluginConfig]/config/minute became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[RateLimitingPluginConfig]/config/month became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[RateLimitingPluginConfig]/config/path became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[RateLimitingPluginConfig]/config/redis/host became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[RateLimitingPluginConfig]/config/redis/password became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[RateLimitingPluginConfig]/config/redis/server_name became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[RateLimitingPluginConfig]/config/redis/username became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[RateLimitingPluginConfig]/config/second became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[RateLimitingPluginConfig]/config/year became nullable for the status 201

      response-property-became-nullable

    • ○

      the request property allOf[PluginBase]/partials/items/name became nullable

      request-property-became-nullable

    • ○

      the request property allOf[PluginBase]/partials/items/path became nullable

      request-property-became-nullable

    • ○

      the request property allOf[RateLimitingPluginConfig]/config became nullable

      request-property-became-nullable

    • ○

      the request property allOf[RateLimitingPluginConfig]/config/day became nullable

      request-property-became-nullable

    • ○

      the request property allOf[RateLimitingPluginConfig]/config/header_name became nullable

      request-property-became-nullable

    • ○

      the request property allOf[RateLimitingPluginConfig]/config/hour became nullable

      request-property-became-nullable

    • ○

      the request property allOf[RateLimitingPluginConfig]/config/minute became nullable

      request-property-became-nullable

    • ○

      the request property allOf[RateLimitingPluginConfig]/config/month became nullable

      request-property-became-nullable

    • ○

      the request property allOf[RateLimitingPluginConfig]/config/path became nullable

      request-property-became-nullable

    • ○

      the request property allOf[RateLimitingPluginConfig]/config/redis/host became nullable

      request-property-became-nullable

    • ○

      the request property allOf[RateLimitingPluginConfig]/config/redis/password became nullable

      request-property-became-nullable

    • ○

      the request property allOf[RateLimitingPluginConfig]/config/redis/server_name became nullable

      request-property-became-nullable

    • ○

      the request property allOf[RateLimitingPluginConfig]/config/redis/username became nullable

      request-property-became-nullable

    • ○

      the request property allOf[RateLimitingPluginConfig]/config/second became nullable

      request-property-became-nullable

    • ○

      the request property allOf[RateLimitingPluginConfig]/config/year became nullable

      request-property-became-nullable

    • ○

      the database request property default value 0 was added

      request-property-default-value-added

    • ○

      the enabled request property default value true was added

      request-property-default-value-added

    • ○

      the error_code request property default value 429 was added

      request-property-default-value-added

    • ○

      the error_message request property default value API rate limit exceeded was added

      request-property-default-value-added

    • ○

      the fault_tolerant request property default value true was added

      request-property-default-value-added

    • ○

      the hide_client_headers request property default value false was added

      request-property-default-value-added

    • ○

      the limit_by request property default value consumer was added

      request-property-default-value-added

    • ○

      the policy request property default value local was added

      request-property-default-value-added

    • ○

      the port request property default value 6379 was added

      request-property-default-value-added

    • ○

      the protocols request property default value grpc grpcs http https was added

      request-property-default-value-added

    • ○

      the ssl request property default value false was added

      request-property-default-value-added

    • ○

      the ssl_verify request property default value false was added

      request-property-default-value-added

    • ○

      the sync_rate request property default value -1 was added

      request-property-default-value-added

    • ○

      the timeout request property default value 2000 was added

      request-property-default-value-added

    • ○

      the database response's property default value 0 was added for the status 201

      response-property-default-value-added

    • ○

      the enabled response's property default value true was added for the status 201

      response-property-default-value-added

    • ○

      the error_code response's property default value 429 was added for the status 201

      response-property-default-value-added

    • ○

      the error_message response's property default value API rate limit exceeded was added for the status 201

      response-property-default-value-added

    • ○

      the fault_tolerant response's property default value true was added for the status 201

      response-property-default-value-added

    • ○

      the hide_client_headers response's property default value false was added for the status 201

      response-property-default-value-added

    • ○

      the limit_by response's property default value consumer was added for the status 201

      response-property-default-value-added

    • ○

      the policy response's property default value local was added for the status 201

      response-property-default-value-added

    • ○

      the port response's property default value 6379 was added for the status 201

      response-property-default-value-added

    • ○

      the protocols response's property default value grpc grpcs http https was added for the status 201

      response-property-default-value-added

    • ○

      the ssl response's property default value false was added for the status 201

      response-property-default-value-added

    • ○

      the ssl_verify response's property default value false was added for the status 201

      response-property-default-value-added

    • ○

      the sync_rate response's property default value -1 was added for the status 201

      response-property-default-value-added

    • ○

      the timeout response's property default value 2000 was added for the status 201

      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

  • 2c77aeaee5fb11See the full diff
    • ▲

      the response property allOf[PluginBase]/tags became nullable for the status 201

      response-property-became-nullable

    • ○

      the request property allOf[PluginBase]/tags became nullable

      request-property-became-nullable

  • c308b7426a7c2See the full diff
    • ▲

      the allOf[RateLimitingPluginConfig]/protocols request property type/format changed from array/ to array/set

      request-property-type-changed

    • ▲

      the allOf[RateLimitingPluginConfig]/protocols response's property type/format changed from array/ to array/set for status 201

      response-property-type-changed

  • 69704304ad5f2See the full diff
    • ○

      added the new optional request property allOf[PluginBase]/partials

      new-optional-request-property

    • ○

      added the optional property allOf[PluginBase]/partials to the response with the 201 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