Apache APISIX · Schema

Apache APISIX Consumer Group

A Consumer Group is a set of plugins that can be applied to multiple consumers rather than configuring each consumer individually.

ApacheAPI GatewayCloud NativeKubernetesLuaNGINXOpen SourceTraffic Management

Properties

Name	Type	Description
desc	string	Description of the consumer group.
plugins	object	Plugin configuration shared among consumers in this group.
labels	object	Key-value pairs for categorization.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/api-evangelist/apache-apisix/blob/main/json-schema/consumer-group.json",
  "title": "Apache APISIX Consumer Group",
  "description": "A Consumer Group is a set of plugins that can be applied to multiple consumers rather than configuring each consumer individually.",
  "type": "object",
  "properties": {
    "desc": {
      "type": "string",
      "description": "Description of the consumer group."
    },
    "plugins": {
      "type": "object",
      "description": "Plugin configuration shared among consumers in this group."
    },
    "labels": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Key-value pairs for categorization."
    }
  }
}