Create a new Consumer Group

Create a new Consumer Group

post

Path Parameters

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 new Consumer Group for creation

ConsumerGroup

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

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 created Consumer Group

ConsumerGroup

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

namestringrequired

The name of the consumer group.

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

post/control-planes/{controlPlaneId}/core-entities/consumer_groups

Body

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

Delete a Consumer Group

Delete a Consumer Group

delete

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

Successfully deleted Consumer Group or the resource didn’t exist

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

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.

idstring

A string representing a UUID (universally unique identifier).

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.

idstring

A string representing a UUID (universally unique identifier).

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

Remove consumers from consumer group

Pre-release Endpoint
This endpoint is currently in beta and is subject to change.

Removes all consumers from a Consumer Groups. This operation does not delete the consumer group.

delete

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

Consumers removed from group

delete/control-planes/{controlPlaneId}/core-entities/consumer_groups/{ConsumerGroupId}/consumers