Sign in
Kafka Clusters (usm/v1)

List of Kafka Clusters

Preview

Retrieve a sorted, filtered, paginated list of all kafka clusters.

get/usm/v1/kafka-clusters

Query parameters

environmentstring required

Filter a collection by a string search

Filter the results by exact match for environment.

page_sizeinteger

A pagination size for collection requests.

page_tokenstring

An opaque pagination token for collection requests.

Response

Kafka Cluster.

api_version'usm/v1' required

APIVersion defines the schema version of this representation of a resource.

kind'KafkaClusterList' required

Kind defines the object this REST resource represents.

Example response

{
  "metadata": {
    "first": "https://api.confluent.cloud/usm/v1/kafka-clusters",
    "last": "https://api.confluent.cloud/usm/v1/kafka-clusters?page_token=bcAOehAY8F16YD84Z1wT",
    "prev": "https://api.confluent.cloud/usm/v1/kafka-clusters?page_token=YIXRY97wWYmwzrax4dld",
    "next": "https://api.confluent.cloud/usm/v1/kafka-clusters?page_token=UvmDWOB1iwfAIBPj6EYb",
    "total_size": 123
  },
  "data": [
    {
      "id": "dlz-f3a90de",
      "display_name": "My-Prod-CP-Cluster",
      "confluent_platform_kafka_cluster_id": "4k0R9d1GTS5tI9f4Y2xZ0Q",
      "cloud": "AWS",
      "region": "us-east-1",
      "environment": {
        "id": "env-00000",
        "related": "https://api.confluent.cloud/v2/environments/env-00000",
        "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000"
      }
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.