Sign in
Plugins

Create a AiRateLimitingAdvanced plugin

Create a AiRateLimitingAdvanced plugin

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

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'ai-rate-limiting-advanced' 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 AiRateLimitingAdvanced 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'ai-rate-limiting-advanced' 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.464118

  • 4a39c7f8550922See the full diff
    • ▲

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

      request-property-type-changed

    • ▲

      the allOf[AiRateLimitingAdvancedPluginConfig]/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

  • 7d6a643707d9410See the full diff
    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

      the response property allOf[AiRateLimitingAdvancedPluginConfig]/config became optional for the status 201

      response-property-became-optional

    • ▲

      the response property allOf[AiRateLimitingAdvancedPluginConfig]/config/llm_providers became optional for the status 201

      response-property-became-optional

    • ○

      added the new optional request property allOf[AiRateLimitingAdvancedPluginConfig]/config/policies

      new-optional-request-property

    • ○

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

      new-optional-request-property

    • ○

      the request property allOf[AiRateLimitingAdvancedPluginConfig]/config became nullable

      request-property-became-nullable

    • ○

      the request property allOf[AiRateLimitingAdvancedPluginConfig]/config/llm_providers became nullable

      request-property-became-nullable

    • ○

      the request property allOf[AiRateLimitingAdvancedPluginConfig]/config became optional

      request-property-became-optional

    • ○

      the request property allOf[AiRateLimitingAdvancedPluginConfig]/config/llm_providers became optional

      request-property-became-optional

    • ○

      the llm_format request property default value openai was removed

      request-property-default-value-removed

    • ○

      added the optional property allOf[AiRateLimitingAdvancedPluginConfig]/config/policies to the response with the 201 status

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

      the llm_format response's property default value openai was removed for the status 201

      response-property-default-value-removed

  • ad02b4e24eb228See the full diff
    • ●

      added the new anthropic enum value to the allOf[AiRateLimitingAdvancedPluginConfig]/config/llm_format response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new customCost enum value to the allOf[AiRateLimitingAdvancedPluginConfig]/config/llm_providers/items/name response property for the response status 201

      response-property-enum-value-added

    • ○

      added the new optional request property allOf[AiRateLimitingAdvancedPluginConfig]/config/custom_cost_count_function

      new-optional-request-property

    • ○

      added the new optional request property allOf[AiRateLimitingAdvancedPluginConfig]/config/decrease_by_fractions_in_redis

      new-optional-request-property

    • ○

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

      new-optional-request-property

    • ○

      added the new anthropic enum value to the request property allOf[AiRateLimitingAdvancedPluginConfig]/config/llm_format

      request-property-enum-value-added

    • ○

      added the new customCost enum value to the request property allOf[AiRateLimitingAdvancedPluginConfig]/config/llm_providers/items/name

      request-property-enum-value-added

    • ○

      added the optional property allOf[AiRateLimitingAdvancedPluginConfig]/config/custom_cost_count_function to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property allOf[AiRateLimitingAdvancedPluginConfig]/config/decrease_by_fractions_in_redis to the response with the 201 status

      response-optional-property-added

    • ○

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

      response-optional-property-added

  • 19e869275e282See the full diff
    • ▲

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

      request-property-type-changed

    • ▲

      the allOf[AiRateLimitingAdvancedPluginConfig]/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

  • 96118a9cd7f41775See the full diff
    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

      the response property allOf[AiRateLimitingAdvancedPluginConfig]/config/redis/cluster_nodes became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[AiRateLimitingAdvancedPluginConfig]/config/redis/keepalive_backlog became nullable for the status 201

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

      the response property allOf[AiRateLimitingAdvancedPluginConfig]/config/redis/sentinel_master became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[AiRateLimitingAdvancedPluginConfig]/config/redis/sentinel_nodes became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[AiRateLimitingAdvancedPluginConfig]/config/redis/sentinel_password became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[AiRateLimitingAdvancedPluginConfig]/config/redis/sentinel_username became nullable for the status 201

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

      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 request property allOf[AiRateLimitingAdvancedPluginConfig]/config/header_name became nullable

      request-property-became-nullable

    • ○

      the request property allOf[AiRateLimitingAdvancedPluginConfig]/config/namespace became nullable

      request-property-became-nullable

    • ○

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

      request-property-became-nullable

    • ○

      the request property allOf[AiRateLimitingAdvancedPluginConfig]/config/redis became nullable

      request-property-became-nullable

    • ○

      the request property allOf[AiRateLimitingAdvancedPluginConfig]/config/redis/cluster_nodes became nullable

      request-property-became-nullable

    • ○

      the request property allOf[AiRateLimitingAdvancedPluginConfig]/config/redis/keepalive_backlog became nullable

      request-property-became-nullable

    • ○

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

      request-property-became-nullable

    • ○

      the request property allOf[AiRateLimitingAdvancedPluginConfig]/config/redis/sentinel_master became nullable

      request-property-became-nullable

    • ○

      the request property allOf[AiRateLimitingAdvancedPluginConfig]/config/redis/sentinel_nodes became nullable

      request-property-became-nullable

    • ○

      the request property allOf[AiRateLimitingAdvancedPluginConfig]/config/redis/sentinel_password became nullable

      request-property-became-nullable

    • ○

      the request property allOf[AiRateLimitingAdvancedPluginConfig]/config/redis/sentinel_username became nullable

      request-property-became-nullable

    • ○

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

      request-property-became-nullable

    • ○

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

      request-property-became-nullable

    • ○

      the request property allOf[AiRateLimitingAdvancedPluginConfig]/config/request_prompt_count_function became nullable

      request-property-became-nullable

    • ○

      the request property allOf[AiRateLimitingAdvancedPluginConfig]/config/sync_rate became nullable

      request-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 cluster_max_redirections request property default value 5 was added

      request-property-default-value-added

    • ○

      the connect_timeout request property default value 2000 was added

      request-property-default-value-added

    • ○

      the connection_is_proxied request property default value false was added

      request-property-default-value-added

    • ○

      the database request property default value 0 was added

      request-property-default-value-added

    • ○

      the dictionary_name request property default value kong_rate_limiting_counters was added

      request-property-default-value-added

    • ○

      the disable_penalty request property default value false 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_hide_providers request property default value false was added

      request-property-default-value-added

    • ○

      the error_message request property default value AI token rate limit exceeded for provider(s): was added

      request-property-default-value-added

    • ○

      the hide_client_headers request property default value false was added

      request-property-default-value-added

    • ○

      the host request property default value 127.0.0.1 was added

      request-property-default-value-added

    • ○

      the host request property default value 127.0.0.1 was added

      request-property-default-value-added

    • ○

      the identifier request property default value consumer was added

      request-property-default-value-added

    • ○

      the ip request property default value 127.0.0.1 was added

      request-property-default-value-added

    • ○

      the keepalive_pool_size request property default value 256 was added

      request-property-default-value-added

    • ○

      the llm_format request property default value openai was added

      request-property-default-value-added

    • ○

      the port request property default value 6379 was added

      request-property-default-value-added

    • ○

      the port request property default value 6379 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 read_timeout request property default value 2000 was added

      request-property-default-value-added

    • ○

      the retry_after_jitter_max request property default value 0 was added

      request-property-default-value-added

    • ○

      the send_timeout request property default value 2000 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 strategy request property default value local was added

      request-property-default-value-added

    • ○

      the tokens_count_strategy request property default value total_tokens was added

      request-property-default-value-added

    • ○

      the window_type request property default value sliding was added

      request-property-default-value-added

    • ○

      the cluster_max_redirections response's property default value 5 was added for the status 201

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

      the dictionary_name response's property default value kong_rate_limiting_counters was added for the status 201

      response-property-default-value-added

    • ○

      the disable_penalty response's property default value false 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_hide_providers response's property default value false was added for the status 201

      response-property-default-value-added

    • ○

      the error_message response's property default value AI token rate limit exceeded for provider(s): 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 host response's property default value 127.0.0.1 was added for the status 201

      response-property-default-value-added

    • ○

      the host response's property default value 127.0.0.1 was added for the status 201

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

      the ip response's property default value 127.0.0.1 was added for the status 201

      response-property-default-value-added

    • ○

      the keepalive_pool_size response's property default value 256 was added for the status 201

      response-property-default-value-added

    • ○

      the llm_format response's property default value openai 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 port response's property default value 6379 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 read_timeout response's property default value 2000 was added for the status 201

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

      the send_timeout response's property default value 2000 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 strategy response's property default value local was added for the status 201

      response-property-default-value-added

    • ○

      the tokens_count_strategy response's property default value total_tokens was added for the status 201

      response-property-default-value-added

    • ○

      the window_type response's property default value sliding 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

  • 2c77aeaee5fb327See the full diff
    • ▲

      the request property allOf[AiRateLimitingAdvancedPluginConfig]/config became required

      request-property-became-required

    • ▲

      the request property allOf[AiRateLimitingAdvancedPluginConfig]/config/llm_providers became required

      request-property-became-required

    • ▲

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

      response-property-became-nullable

    • ●

      added the new cohere enum value to the allOf[AiRateLimitingAdvancedPluginConfig]/config/llm_format response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new huggingface enum value to the allOf[AiRateLimitingAdvancedPluginConfig]/config/llm_format response property for the response status 201

      response-property-enum-value-added

    • ○

      added the new optional request property allOf[AiRateLimitingAdvancedPluginConfig]/config/namespace

      new-optional-request-property

    • ○

      the request property allOf[PluginBase]/tags became nullable

      request-property-became-nullable

    • ○

      added the new cohere enum value to the request property allOf[AiRateLimitingAdvancedPluginConfig]/config/llm_format

      request-property-enum-value-added

    • ○

      added the new huggingface enum value to the request property allOf[AiRateLimitingAdvancedPluginConfig]/config/llm_format

      request-property-enum-value-added

    • ○

      added the optional property allOf[AiRateLimitingAdvancedPluginConfig]/config/namespace to the response with the 201 status

      response-optional-property-added

    • ○

      the response property allOf[AiRateLimitingAdvancedPluginConfig]/config became required for the status 201

      response-property-became-required

    • ○

      the response property allOf[AiRateLimitingAdvancedPluginConfig]/config/llm_providers became required for the status 201

      response-property-became-required

  • c308b7426a7c2See the full diff
    • ▲

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

      request-property-type-changed

    • ▲

      the allOf[AiRateLimitingAdvancedPluginConfig]/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