Give Feedback

pydo.databases.list_kafka_topics()

Generated on 7 Jul 2026 from pydo version v0.39.0

Copy page as Markdown View page as Markdown

Usage

client.databases.list_kafka_topics(
    database_cluster_uuid="9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
)

Returns JSONRaises HttpResponseError

Description

To list all of a Kafka cluster’s topics, send a GET request to /v2/databases/{database_cluster_uuid}/topics.

The result will be a JSON object with a topics key.

Parameters

database_cluster_uuid string required: A unique identifier for a database cluster.

Response Example

Show Response Example

{
  "topics": [
    {
      "name": "customer-events",
      "state": "active",
      "replication_factor": 2,
      "partition_count": 3
    },
    {
      "name": "engineering-events",
      "state": "configuring",
      "replication_factor": 2,
      "partition_count": 10
    }
  ]
}

More Information

See /v2/databases/{database_cluster_uuid}/topics in the API reference for additional detail on responses, headers, parameters, and more.