Apache APISIX · Schema

Apache APISIX Plugin Config

A Plugin Config is a reusable set of plugin configurations that can be bound to routes.

ApacheAPI GatewayCloud-NativeKubernetesLuaNGINXOpen-SourceTraffic Management

Properties

Name Type Description
desc string Description of the plugin config.
plugins object Plugin configuration.
labels object Key-value pairs for categorization.
View JSON Schema on GitHub

JSON Schema

plugin-config.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/api-evangelist/apache-apisix/blob/main/json-schema/plugin-config.json",
  "title": "Apache APISIX Plugin Config",
  "description": "A Plugin Config is a reusable set of plugin configurations that can be bound to routes.",
  "type": "object",
  "properties": {
    "desc": {
      "type": "string",
      "description": "Description of the plugin config."
    },
    "plugins": {
      "type": "object",
      "description": "Plugin configuration."
    },
    "labels": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Key-value pairs for categorization."
    }
  }
}