---
title: "List of Kafka Clusters"
method: GET
path: "/usm/v1/kafka-clusters"
tags: ["Kafka Clusters (usm/v1)"]
---

# List of Kafka Clusters

`GET /usm/v1/kafka-clusters`

[![Preview](https://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afba)](#section/Versioning/API-Lifecycle-Policy)

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

## Query parameters

- `environment` string, required — Filter a collection by a string search
- `page_size` integer
- `page_token` string

## Response `200`

Kafka Cluster.

- object — `KafkaCluster` object represent Confluent Platform Kafka clusters registered with Confluent Cloud. The API allows you to create and delete KafkaCluster. ## The Kafka Clusters Model <SchemaDefinition schemaRef="#/components/schemas/usm.v1.KafkaCluster" />
  - `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.
  - `metadata` object, required — ListMeta describes metadata that resource collections may have
    - `first` string, uri, nullable — A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported.
    - `last` string, uri, nullable — A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported.
    - `prev` string, uri, nullable — A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported.
    - `next` string, uri, nullable — A link to the next page of results. If a response does not contain a next link, then there is no more data available.
    - `total_size` integer — Number of records in the full result set. This response may be paginated and have a smaller number of records.
  - `data` object[], required — A data property that contains an array of resource items. Each entry in the array is a separate resource.
    - `api_version` 'usm/v1' — APIVersion defines the schema version of this representation of a resource.
    - `kind` 'KafkaCluster' — Kind defines the object this REST resource represents.
    - `id` string, required — ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space").
    - `display_name` string, required — A human-readable name for the Confluent Platform Kafka cluster.
    - `confluent_platform_kafka_cluster_id` string, required — The unique identifier of the Kafka cluster within the Confluent Platform environment.
    - `cloud` string, required — The cloud service provider where the metadata for the Kafka Cluster should be stored.
    - `region` string, required — The home region of the Confluent Platform Kafka cluster where the metadata should be stored.
    - `environment` object, required — The environment to which this belongs.
      - `id` string, required — ID of the referred resource
      - `environment` string — Environment of the referred resource, if env-scoped
      - `related` string, uri, required — API URL for accessing or modifying the referred object
      - `resource_name` string, uri, required — CRN reference to the referred resource

## Other responses

- `400` — Bad Request
- `401` — The request lacks valid authentication credentials for this resource.
- `403` — The access credentials were considered insufficient to grant access
- `429` — Rate Limit Exceeded
- `500` — Oops, something went wrong!

---

[API](https://skmtc.dev/confluent/apis/confluent-cloud-apis.md) · [All operations](https://skmtc.dev/confluent/apis/confluent-cloud-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/confluent/confluent-cloud-apis/revisions/a6a73f98a698/schema)