Kong · Schema

PluginBase

A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the [Kong Hub](https://docs.konghq.com/hub/). When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the `service` and `consumer` fields.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
condition	string	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_at	integer	Unix epoch when the resource was created.
enabled	boolean	Whether the plugin is applied.
id	string	A string representing a UUID (universally unique identifier).
instance_name	string	A unique string representing a UTF-8 encoded name.
name	string	The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.
ordering	object
partials	array	A list of partials to be used by the plugin.
tags	array	An optional set of strings associated with the Plugin for grouping and filtering.
updated_at	integer	Unix epoch when the resource was last updated.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PluginBase",
  "title": "PluginBase",
  "description": "A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the [Kong Hub](https://docs.konghq.com/hub/). When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the `service` and `consumer` fields.",
  "type": "object",
  "properties": {
    "condition": {
      "description": "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.",
      "type": "string",
      "maxLength": 1024,
      "nullable": true
    },
    "created_at": {
      "description": "Unix epoch when the resource was created.",
      "type": "integer",
      "nullable": true
    },
    "enabled": {
      "description": "Whether the plugin is applied.",
      "type": "boolean",
      "default": true,
      "nullable": true
    },
    "id": {
      "description": "A string representing a UUID (universally unique identifier).",
      "type": "string",
      "minLength": 1,
      "nullable": true
    },
    "instance_name": {
      "description": "A unique string representing a UTF-8 encoded name.",
      "type": "string",
      "nullable": true
    },
    "name": {
      "description": "The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.",
      "type": "string",
      "minLength": 1
    },
    "ordering": {
      "type": "object",
      "nullable": true,
      "properties": {
        "after": {
          "type": "object",
          "properties": {
            "access": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        },
        "before": {
          "type": "object",
          "properties": {
            "access": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "partials": {
      "description": "A list of partials to be used by the plugin.",
      "type": "array",
      "items": {
        "properties": {
          "id": {
            "description": "A string representing a UUID (universally unique identifier).",
            "type": "string",
            "minLength": 1
          },
          "name": {
            "description": "A unique string representing a UTF-8 encoded name.",
            "type": "string"
          },
          "path": {
            "type": "string"
          }
        },
        "type": "object"
      }
    },
    "tags": {
      "description": "An optional set of strings associated with the Plugin for grouping and filtering.",
      "type": "array",
      "items": {
        "description": "A string representing a tag.",
        "type": "string"
      },
      "nullable": true
    },
    "updated_at": {
      "description": "Unix epoch when the resource was last updated.",
      "type": "integer",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}