Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kong Consumer Groups API

Consumer groups enable the organization and categorization of consumers (users or applications) within an API ecosystem.By grouping consumers together, you eliminate the need to manage them individually, providing a scalable, efficient approach to managing configurations.

Kong Consumer Groups API is one of 139 APIs that Kong publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Consumer Groups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, an API reference, authentication docs, and 1 JSON Schema.

This API exposes 15 operations across 8 paths, and defines 8 schemas. It is described by OpenAPI 3.1.0, at version 3.14.0.

Requests are made against a single base URL, {protocol}://{hostname}:{port}{path}.

15 operations 8 paths 8 schemas 5 DELETE4 GET4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
API Key
Contact
License
Resource Areas
1

Authentication & Security 1

Kong Consumer Groups API declares 1 security scheme for authenticating requests. An API key is passed in the header as Kong-Admin-Token (adminToken). By default, every request must be authenticated.

Paths & Operations 15

Across 8 paths, the API surfaces 15 operations — 5 DELETE, 4 GET, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Consumer Groups 15

Consumer groups enable the organization and categorization of consumers (users or applications) within an API ecosystem. By grouping consumers together, you eliminate the need to…

POST
/{workspace}/consumer_groups
Create a new Consumer Group
create-consumer_group 1 param body → 201401
DELETE
/{workspace}/consumer_groups/{ConsumerGroupId}
Delete a Consumer Group
delete-consumer_group 3 params → 204401
GET
/{workspace}/consumer_groups/{ConsumerGroupId}
Get a Consumer Group
get-consumer_group 2 params → 200401404
PUT
/{workspace}/consumer_groups/{ConsumerGroupId}
Upsert a Consumer Group
upsert-consumer_group 2 params body → 200401
POST
/{workspace}/consumer_groups/{ConsumerGroupId}/consumers
Add consumer to consumer group
add-consumer-to-group 2 params body → 201
DELETE
/{workspace}/consumer_groups/{ConsumerGroupId}/consumers/{ConsumerIdOrUsername}
Remove consumer from consumer group
remove-consumer-from-group 3 params → 204
GET
/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups
List all Consumer Groups
list-consumer_group 4 params → 200401
POST
/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups
Create a new Consumer Group
create-consumer_group 1 param body → 201401
DELETE
/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups/{ConsumerGroupId}
Delete a Consumer Group
delete-consumer_group 3 params → 204401
GET
/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups/{ConsumerGroupId}
Get a Consumer Group
get-consumer_group 3 params → 200401404
PUT
/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups/{ConsumerGroupId}
Upsert a Consumer Group
upsert-consumer_group 2 params body → 200401
DELETE
/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups/{ConsumerGroupId}/consumers
Remove consumers from consumer group
remove-all-consumers-from-consumer-group 2 params → 204404
GET
/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups/{ConsumerGroupId}/consumers
List all Consumers in a Consumer Group
list-consumers-for-consumer-group 5 params → 200
POST
/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups/{ConsumerGroupId}/consumers
Add consumer to consumer group
add-consumer-to-group 2 params body → 201
DELETE
/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups/{ConsumerGroupId}/consumers/{ConsumerId}
Remove consumer from consumer group
remove-consumer-from-group 3 params → 204

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Consumer_2 (6 properties), Consumer (6 properties), ConsumerGroup (5 properties), ConsumerGroup_2 (5 properties). Each schema is shown below with its type and property counts.

Consumer_2
object
The Consumer object represents a consumer - or a user - of a Service. You can either rely on Kong as the primary datastore, or you can map the consumer list wi…
6 properties
ConsumerGroupInsideWrapper
object
1 property
PaginationNextResponse
string
URI to the next page (may be null)
ConsumerGroup_2
object
5 properties 1 required
PaginationOffsetResponse
string
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page
ConsumerGroup
object
5 properties 1 required
Consumer
object
The Consumer object represents a consumer - or a user - of a Service. You can either rely on Kong as the primary datastore, or you can map the consumer list wi…
6 properties
GatewayUnauthorizedError
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-consumer-groups-api-openapi.yml Raw ↑

Other APIs Kong publishes across the network.

Kong Gateway
Kong AI Gateway
Kong Agent Gateway
Kong MCP Registry
Kong Context Mesh
Kong Mesh
Kong Insomnia
Kong ACLs API
Kong Add-Ons API
Kong API API
Kong API Attributes API
Kong API Documentation API