Create a consumer group
Create a consumer group by passing a name and optional tags in the request body.
Path Parameters
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
Consumer groups request body
A unique name for the consumer group you want to create.
Example:Example
An optional set of strings associated with the consumer group for grouping and filtering.
Response
200
Response
Example response
Show Child Parameters
Authentication
Path Parameters
Body
Delete a consumer group
Delete a consumer group. Deleting a consumer group removes all consumers from that group. This operation does not delete existing consuemrs.
Path Parameters
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
204
Response
HTTP/1.1 204 No Content
Authentication
Path Parameters
List a specific consumer group
Return information about a specific consumer group by passing the group_id as a path parameter.
Query Parameters
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
Number of resources to be returned.
Default:100
>= 1<= 1000
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 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
Query Parameters
Create a consumer group
Create 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
Body
application/json
Body
Consumer request body
The unique username of the Consumer. You must send either this field or custom_id with the request.
Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or username with the request.
An optional set of strings associated with the Consumer for grouping and filtering.
Response
200 application/json
Response
The consumer object response body
Show Child Parameters
Pagination information
Example:http://localhost:8001/consumers?offset=6378122c-a0a1-438d-a5c6-efabae9fb969
Authentication
Path Parameters
Body
Delete consumer group
Delete 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
204
Response
No Content