Skip to content

http request list cluster topics

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

Name

List Cluster Topics

Usage

This endpoint returns a list of the topics in the specified Kafka cluster.

URL path

GET /v3/kafka/(cluster)/topic

Parameters

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

Response

The response contains a topics key whose value is a list of topic names:

{
  "error": false,
  "message": "broker topic list returned",
  "topics": [
    "topicA",
    "topicB"
  ],
  "request": {
    "url": "/v3/kafka/clustername/topic",
    "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.
  • JSON Encoding Error If there is a failure encoding the JSON response, a 500 error will be returned with a JSON response body.