Get a Consumer Group

Get a Consumer Group using ID.

get

Path Parameters

ConsumerGroupIdstringrequired

ID of the Consumer Group to lookup

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

Response

application/json

Successfully fetched Consumer Group

ConsumerGroupInsideWrapper

consumer_groupobject
* Additional properties are NOT allowed.
Show Child Parameters
get/control-planes/{controlPlaneId}/core-entities/consumer_groups/{ConsumerGroupId}
 
application/json

Upsert a Consumer Group

Create or Update Consumer Group using ID.

put

Path Parameters

ConsumerGroupIdstringrequired

ID of the Consumer Group to lookup

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

Body

application/json

Description of the Consumer Group

ConsumerGroup

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

idstring

A string representing a UUID (universally unique identifier).

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
namestringrequired

The name of the consumer group.

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

Response

application/json

Successfully upserted Consumer Group

ConsumerGroup

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

idstring

A string representing a UUID (universally unique identifier).

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
namestringrequired

The name of the consumer group.

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

put/control-planes/{controlPlaneId}/core-entities/consumer_groups/{ConsumerGroupId}

Body

{ "name": "name" }
 
application/json

List all Consumers in a Consumer Group

List all consumers in a consumer group

get

Query Parameters

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

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

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

ConsumerGroupIdstringrequired

The UUID or name of the consumer group

Example:cf4c7e60-11db-49dd-b300-7c7e5f0f7e6b

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

Response

200 application/json

A successful response listing of consumers

dataarray[object]

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"}

* Additional properties are NOT allowed.
Show Child Parameters
nextstring

URI to the next page (may be null)

offsetstring

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

get/control-planes/{controlPlaneId}/core-entities/consumer_groups/{ConsumerGroupId}/consumers
 
200 application/json

Add consumer to consumer group

Add a consumer to a consumer group

post

Path Parameters

ConsumerGroupIdstringrequired

The UUID or name of the consumer group

Example:cf4c7e60-11db-49dd-b300-7c7e5f0f7e6b

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

Body

application/json
consumerstring

Example:cf4c7e60-11db-49dd-b300-7c7e5f0f7e6b

Response

201 application/json

Consumer added to group

consumer_groupobject
* Additional properties are NOT allowed.
Show Child Parameters
consumersarray[object]

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"}

* Additional properties are NOT allowed.
Show Child Parameters
post/control-planes/{controlPlaneId}/core-entities/consumer_groups/{ConsumerGroupId}/consumers

Body

{}
 
201 application/json

Consumers

The consumer object represents a consumer - or a user - of a service.
You can either rely on Kong Gateway as the primary datastore, or you can map the consumer list with your database to keep consistency between Kong Gateway and your existing primary datastore.