Skip to content

http request list clusters

Todd Palino edited this page Dec 1, 2017 · 7 revisions

Name

List Clusters

Usage

This endpoint returns a list of the Kafka clusters that Burrow is configured with. The response is the same regardless of which URL path is used.

URL path

GET /v3/kafka

Parameters

None

Response

The response contains a clusters key whose value is a list of cluster names:

{
  "error": false,
  "message": "cluster list returned",
  "clusters": [
    "clustername1",
    "clustername2"
  ],
  "request": {
    "uri": "/v2/kafka",
    "host": "responding.host.example.com",
  }
}

Possible errors

  • JSON Encoding Error If there is a failure encoding the JSON response, a 500 error will be returned with a JSON response body.