List a specific consumer group

Return information about a specific consumer group by passing the group_id as a path parameter.

get

Query Parameters

offsetstring

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

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

tagsstring

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

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

group_idstringrequired

The UUID of the consumer group.

Example:be4bcfca-b1df-4fac-83cc-5cf6774bf48e

Response

200

Example response

dataarray[object]
Show Child Parameters
get/runtime-groups/{runtimeGroupId}/core-entities/consumer_groups/{group_id}
 
200

Create a consumer group

Create a consumer group.

put

Path Parameters

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

group_idstringrequired

The UUID of the consumer group.

Example:be4bcfca-b1df-4fac-83cc-5cf6774bf48e

Body

application/json

Consumer request body

usernamestringrequired

The unique username of the Consumer. You must send either this field or custom_id with the request.

custom_idstringrequired

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.

tagsarray[string]

An optional set of strings associated with the Consumer for grouping and filtering.

Response

200 application/json

The consumer object response body

dataarray[object]
Show Child Parameters
nextstring

Pagination information

Example:http://localhost:8001/consumers?offset=6378122c-a0a1-438d-a5c6-efabae9fb969

put/runtime-groups/{runtimeGroupId}/core-entities/consumer_groups/{group_id}

Body

{ "username": "username", "custom_id": "custom_id" }
 
200 application/json

Delete consumer group

Delete consumer group.

delete

Path Parameters

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

group_idstringrequired

The UUID of the consumer group.

Example:be4bcfca-b1df-4fac-83cc-5cf6774bf48e

Response

204

No Content

delete/runtime-groups/{runtimeGroupId}/core-entities/consumer_groups/{group_id}
 
204

List all consumers in a consumer group

Returns a list of consumers that belong to a consumer group.

get

Path Parameters

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

group_idstringrequired

The UUID of the consumer group.

Example:be4bcfca-b1df-4fac-83cc-5cf6774bf48e

Response

200

Example response

dataarray[object]
Show Child Parameters
get/runtime-groups/{runtimeGroupId}/core-entities/consumer_groups/{group_id}/consumers
 
200

Add a consumer to a group

Add a consumer to a group

post

Path Parameters

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

group_idstringrequired

The UUID of the consumer group.

Example:be4bcfca-b1df-4fac-83cc-5cf6774bf48e

Body

application/json
consumerstring

The consumer ID for the consumer that you want to add to a group.

Example:288f2bfc-04e2-4ec3-b6f3-40408dff5417

Response

201 application/json

The response body returns a consumer group and the associated consumers.

consumer_groupobject
Show Child Parameters
consumersarray[object]
Show Child Parameters
post/runtime-groups/{runtimeGroupId}/core-entities/consumer_groups/{group_id}/consumers

Body

{}
 
201 application/json