Upsert a Consumer Group
Create or Update Consumer Group using ID.
Path Parameters
ID of the Consumer Group to lookup
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
Description of the Consumer Group
ConsumerGroup
Unix epoch when the resource was created.
A string representing a UUID (universally unique identifier).
The name of the consumer group.
A string representing a tag.
Unix epoch when the resource was last updated.
Response
application/json
Response
Successfully upserted Consumer Group
ConsumerGroup
Unix epoch when the resource was created.
A string representing a UUID (universally unique identifier).
The name of the consumer group.
A string representing a tag.
Unix epoch when the resource was last updated.
Authentication
Path Parameters
Body
Remove consumers from consumer group
Pre-release Endpoint
This endpoint is currently in beta and is subject to change.
Removes all consumers from a Consumer Groups. This operation does not delete the consumer group.
Path Parameters
The UUID or name of the consumer group
Example:cf4c7e60-11db-49dd-b300-7c7e5f0f7e6b
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
Response
Consumers removed from group
Authentication
Path Parameters
List all Consumers in a Consumer Group
List all consumers in a consumer group
Query Parameters
Number of resources to be returned.
Default:100
>= 1<= 1000
Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources
A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.
Example:tag1,tag2
Path Parameters
The UUID or name of the consumer group
Example:cf4c7e60-11db-49dd-b300-7c7e5f0f7e6b
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
200 application/json
Response
A successful response listing of consumers
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 with your database to keep consistency between Kong and your existing primary datastore.
Example:{"custom_id":"4200","id":"8a388226-80e8-4027-a486-25e4f7db5d21","tags":["silver-tier"],"username":"bob-the-builder"}
Show Child Parameters
URI to the next page (may be null)
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page
Authentication
Path Parameters
Query Parameters
Add consumer to consumer group
Add a consumer to a consumer group
Path Parameters
The UUID or name of the consumer group
Example:cf4c7e60-11db-49dd-b300-7c7e5f0f7e6b
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
Example:cf4c7e60-11db-49dd-b300-7c7e5f0f7e6b
Response
201 application/json
Response
Consumer added to group
Show Child Parameters
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 with your database to keep consistency between Kong and your existing primary datastore.
Example:{"custom_id":"4200","id":"8a388226-80e8-4027-a486-25e4f7db5d21","tags":["silver-tier"],"username":"bob-the-builder"}
Show Child Parameters
Authentication
Path Parameters
Body
Remove consumer from consumer group
Remove a consumer from a consumer group
Path Parameters
The UUID or name of the consumer group
Example:cf4c7e60-11db-49dd-b300-7c7e5f0f7e6b
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
204
Response
Consumer removed from group