Create a new Consumer Group
Create a new Consumer Group
Path Parameters
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
Description of the new Consumer Group for creation
ConsumerGroup
Unix epoch when the resource was created.
A string representing a UUID (universally unique identifier).
The name of the consumer group.
A string representing a tag.
Unix epoch when the resource was last updated.
Response
application/json
Response
Successfully created Consumer Group
ConsumerGroup
Unix epoch when the resource was created.
A string representing a UUID (universally unique identifier).
The name of the consumer group.
A string representing a tag.
Unix epoch when the resource was last updated.
Authentication
Path Parameters
Body
Delete a Consumer Group
Delete a Consumer Group
Path Parameters
ID of the Consumer Group to lookup
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
Response
Successfully deleted Consumer Group or the resource didn’t exist
Authentication
Path Parameters
Get a Consumer Group
Get a Consumer Group using ID.
Path Parameters
ID of the Consumer Group to lookup
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
Successfully fetched Consumer Group
ConsumerGroupInsideWrapper
Show Child Parameters
Authentication
Path Parameters
Upsert a Consumer Group
Create or Update Consumer Group using ID.
Path Parameters
ID of the Consumer Group to lookup
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
Description of the Consumer Group
ConsumerGroup
Unix epoch when the resource was created.
A string representing a UUID (universally unique identifier).
The name of the consumer group.
A string representing a tag.
Unix epoch when the resource was last updated.
Response
application/json
Response
Successfully upserted Consumer Group
ConsumerGroup
Unix epoch when the resource was created.
A string representing a UUID (universally unique identifier).
The name of the consumer group.
A string representing a tag.
Unix epoch when the resource was last updated.
Authentication
Path Parameters
Body
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.
Path Parameters
The UUID or name of the consumer group
Example:cf4c7e60-11db-49dd-b300-7c7e5f0f7e6b
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
Response
Consumers removed from group