Plugins

Get a AiProxy plugin

get/{workspace}/plugins/{PluginId}#AiProxy

Response

AiProxy 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-proxy' 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 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.

Changes

Changed in 3 of the 11 revisions of this API.1112

Apr 24, 20269555cbb8b2591010See the full diff
- ●
  added the new anthropic enum value to the allOf[AiProxyPluginConfig]/config/llm_format response property for the response status 200
  response-property-enum-value-added
- ●
  added the new cerebras enum value to the allOf[AiProxyPluginConfig]/config/model/provider response property for the response status 200
  response-property-enum-value-added
- ●
  added the new dashscope enum value to the allOf[AiProxyPluginConfig]/config/model/provider response property for the response status 200
  response-property-enum-value-added
- ●
  added the new databricks enum value to the allOf[AiProxyPluginConfig]/config/model/provider response property for the response status 200
  response-property-enum-value-added
- ●
  added the new deepseek enum value to the allOf[AiProxyPluginConfig]/config/model/provider response property for the response status 200
  response-property-enum-value-added
- ●
  added the new ollama enum value to the allOf[AiProxyPluginConfig]/config/model/provider response property for the response status 200
  response-property-enum-value-added
- ●
  added the new video/generation enum value to the allOf[AiProxyPluginConfig]/config/genai_category response property for the response status 200
  response-property-enum-value-added
- ●
  added the new video/v1/videos/generations enum value to the allOf[AiProxyPluginConfig]/config/route_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new vllm enum value to the allOf[AiProxyPluginConfig]/config/model/provider response property for the response status 200
  response-property-enum-value-added
- ●
  added the new xai enum value to the allOf[AiProxyPluginConfig]/config/model/provider response property for the response status 200
  response-property-enum-value-added
- ○
  added the optional property allOf[AiProxyPluginConfig]/config/auth/gcp_metadata_url to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[AiProxyPluginConfig]/config/auth/gcp_oauth_token_url to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[AiProxyPluginConfig]/config/model/model_alias to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[AiProxyPluginConfig]/config/model/options/bedrock/batch_bucket_prefix to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[AiProxyPluginConfig]/config/model/options/bedrock/batch_role_arn to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[AiProxyPluginConfig]/config/model/options/bedrock/video_output_s3_uri to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[AiProxyPluginConfig]/config/model/options/dashscope to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[AiProxyPluginConfig]/config/model/options/databricks to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[PluginBase]/condition to the response with the 200 status
  response-optional-property-added
- ○
  the max_request_body_size response's property default value changed from 8192 to 1048576 for the status 200
  response-property-default-value-changed
Nov 25, 202565f3141f166211See the full diff
- ●
  removed the optional property name from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property allOf[AiProxyPluginConfig]/name to the response with the 200 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 9, 2025740b73588ef41See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 11 revisions, 1 has no diff computed.

Full history