http request remove consumer group

Name

Remove Consumer Group

Usage

This endpoint removes the offsets for a single consumer group from a cluster. This is useful in the case where the topic list for a consumer has changed, and Burrow believes the consumer is consuming topics that it no longer is. The consumer group will be removed, but it will automatically be repopulated if the consumer is continuing to commit offsets.

URL path

DELETE /v3/kafka/(cluster)/consumer/(group)

Parameters

Name	Format	Description
cluster	string	The name of a Kafka cluster, as returned by the [[List Clusters
group	string	The name of a Kafka consumer group, as returned by the [[List Consumers

Response

The response is either a 404 if the consumer group is unknown, or a 200 otherwise:

{
  "error": false,
  "message": "consumer group removed",
  "result": {},
  "request": {
    "url": "/v3/kafka/clustername/consumer/groupname",
    "host": "responding.host.example.com",
  }
}

Possible errors

• Cluster Not Found If an unknown cluster name is provided, a 404 error will be returned with a JSON response body.
• Group Not Found If an unknown consumer group name is provided, a 404 error will be returned with a JSON response body.