List all Consumer Groups in a workspace
List all Consumer Groups in a workspace
Query Parameters
Number of resources to be returned.
Default:100
>= 1<= 1000
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
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
The name of the workspace
Example:team-payments
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
A successful response listing Consumer Groups
Show Child Parameters
URI to the next page (may be null)
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page
Authentication
Path Parameters
Query Parameters
Create a new Consumer Group in a workspace
Create a new Consumer Group in a workspace
Path Parameters
The name of the workspace
Example:team-payments
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.
User-defined entity description. Konnect only field, not synced to the Gateway.
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
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.
User-defined entity description. Konnect only field, not synced to the Gateway.
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
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 in a workspace
Delete a Consumer Group in a workspace
Path Parameters
ID of the Consumer Group to lookup
The name of the workspace
Example:team-payments
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 in a workspace
Get a Consumer Group using ID in a workspace.
Path Parameters
The name of the workspace
Example:team-payments
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 in a workspace
Create or Update Consumer Group using ID in a workspace.
Path Parameters
The name of the workspace
Example:team-payments
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.
User-defined entity description. Konnect only field, not synced to the Gateway.
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
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.
User-defined entity description. Konnect only field, not synced to the Gateway.
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
The name of the consumer group.
A string representing a tag.
Unix epoch when the resource was last updated.