Apache APISIX · JSON Structure

Consumer Group Structure

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

Type: object Properties: 3
ApacheAPI GatewayCloud NativeKubernetesLuaNGINXOpen SourceTraffic Management

Apache APISIX Consumer Group is a JSON Structure definition published by Apache APISIX, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

desc plugins labels

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-apisix/refs/heads/main/json-structure/consumer-group-structure.json",
  "name": "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."
    }
  }
}