Sign in
Plugins

Get a AiPromptGuard plugin

Get a AiPromptGuard plugin

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

Response

AiPromptGuard 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-prompt-guard' 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 15 of the 52 revisions of this API.15438

  • 62c54f1094bb1See the full diff
    • ○

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

      response-property-became-required

  • 7d6a643707d91See the full diff
    • ○

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

      response-optional-property-added

  • 2b2a72c67bd21See the full diff
    • ●

      added the new video/generation enum value to the allOf[AiPromptGuardPluginConfig]/config/genai_category response property for the response status 200

      response-property-enum-value-added

  • ad02b4e24eb211See the full diff
    • ●

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

      response-property-enum-value-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

  • 19e869275e281See the full diff
    • ▲

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

  • 96118a9cd7f457See the full diff
    • ▲

      the response property allOf[AiPromptGuardPluginConfig]/config became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[AiPromptGuardPluginConfig]/config/allow_patterns became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[AiPromptGuardPluginConfig]/config/deny_patterns became nullable for the status 200

      response-property-became-nullable

    • ▲

      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 allow_all_conversation_history response's property default value false 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 genai_category response's property default value text/generation was added for the status 200

      response-property-default-value-added

    • ○

      the llm_format response's property default value openai was added for the status 200

      response-property-default-value-added

    • ○

      the match_all_roles response's property default value false was added for the status 200

      response-property-default-value-added

    • ○

      the max_request_body_size response's property default value 8192 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

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2c77aeaee5fb121See the full diff
    • ▲

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

      response-property-became-nullable

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ○

      added the optional property allOf[AiPromptGuardPluginConfig]/config/genai_category to the response with the 200 status

      response-optional-property-added

  • c308b7426a7c1See the full diff
    • ▲

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

      response-property-type-changed

  • 69704304ad5f1See 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

  • 351c07039f3c1See the full diff
    • ○

      added the optional property allOf[AiPromptGuardPluginConfig]/config/llm_format to the response with the 200 status

      response-optional-property-added