Skip to content

HTTP Endpoint

Todd Palino edited this page Jun 2, 2015 · 14 revisions

The HTTP Server in Burrow provides a convenient way to interact with both Burrow and the Kafka and Zookeeper clusters. Requests are simple HTTP calls (most of them are GET requests), and all responses are formatted as JSON.

##Error Responses For bad requests, Burrow will return an appropriate HTTP status code in the 400 or 500 range. The response body will contain a JSON object with more detail on the particular error encountered:

{
  "error": true,
  "message": "Detailed error message"
}

##Request Endpoints The table below lists all of the supported HTTP requests and links to a detailed page on each one that shows the request and response formats.

Request Method URL Format
[[Healthcheck http-request-healthcheck]] GET
[[List Clusters http-request-list-clusters]] GET
[[Kafka Cluster Detail http-request-kafka-cluster-detail]] GET
[[List Consumers http-request-list-consumers]] GET
[[List Consumer Topics http-request-list-consumer-topics]] GET
[[Consumer Topic Detail http-request-consumer-topic-detail]] GET
[[Consumer Group Status http-request-consumer-group-status]] GET
[[List Cluster Topics http-request-list-cluster-topics]] GET
[[Cluster Topic Detail http-request-cluster-topic-detail]] GET
[[List Clusters http-request-list-clusters]] GET