List all consumers in a consumer group
Returns a list of consumers that belong to a consumer group.
Path Parameters
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The UUID of the consumer group.
Example:be4bcfca-b1df-4fac-83cc-5cf6774bf48e
Response
200
Response
Example response
Show Child Parameters
Authentication
Path Parameters
Add a consumer to a group
Add a consumer to a group
Path Parameters
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The UUID of the consumer group.
Example:be4bcfca-b1df-4fac-83cc-5cf6774bf48e
Body
application/json
Body
The consumer ID for the consumer that you want to add to a group.
Example:288f2bfc-04e2-4ec3-b6f3-40408dff5417
Response
201 application/json
Response
The response body returns a consumer group and the associated consumers.
Show Child Parameters
Show Child Parameters
Authentication
Path Parameters
Body
Remove all consumers from a consumer group
Removes all consumers from a consumer group. Does not delete any consumers.consumers.
Path Parameters
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The UUID of the consumer group.
Example:be4bcfca-b1df-4fac-83cc-5cf6774bf48e
Response
204
Response
No Content
Authentication
Path Parameters
List consumer groups for a consumer
View all consumer groups that a consumer is assigned to.
Path Parameters
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The unique identifier or the username of the Consumer to retrieve.
Example:e94215b0-9198-42ce-bf0b-98afff31b2a7
Response
200
Response
Example response
Show Child Parameters
Authentication
Path Parameters
Add a consumer to a group
Add a consumer to a specific consumer group.
If you add a consumer to multiple groups:
If all groups are allowed by the Rate Limiting Advanced plugin, only the first group’s settings will apply.
Otherwise, whichever group is specified in the Rate Limiting Advanced plugin will be active.
Path Parameters
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The unique identifier or the username of the Consumer to retrieve.
Example:e94215b0-9198-42ce-bf0b-98afff31b2a7
Body
application/json
Body
The consumer group UUID.
Example:1e965e47-d185-4e9e-8bc7-94ea6ae75b2e
Response
200
Response
Example response