List consumer groups

Returns a list of active consumer groups.

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

Response

200

Example response

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

Create a consumer group

Create a consumer group by passing a name and optional tags in the request body.

post

Path Parameters

runtimeGroupIdstringrequired

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

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

Body

application/json

Consumer groups request body

namestringrequired

A unique name for the consumer group you want to create.

Example:Example

tagsarray[string]

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

Response

200

Example response

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

Body

{ "name": "Example", "tags": [ "string" ] }
 
200

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.

delete

Path Parameters

runtimeGroupIdstringrequired

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

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

Response

204

HTTP/1.1 204 No Content

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

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