---
title: "List of Clusters"
method: GET
path: "/ksqldbcm/v2/clusters"
tags: ["Clusters (ksqldbcm/v2)"]
---

# List of Clusters

`GET /ksqldbcm/v2/clusters`

[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)

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

## Query parameters

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

## Response `200`

Cluster.

- object — `Cluster` represents a ksqlDB runtime that you can issue queries to using its API endpoint. It executes SQL statements and queries which under the hood get built into corresponding Kafka Streams topologies. The API allows you to list, create, read, and delete your ksqlDB clusters. Related guide: [ksqlDB in Confluent Cloud](https://docs.confluent.io/cloud/current/ksqldb/ksqldb-cluster-api.html). ## The Clusters Model <SchemaDefinition schemaRef="#/components/schemas/ksqldbcm.v2.Cluster" /> ## Quotas and Limits This resource is subject to the following quotas: | Quota | Description | | --- | --- | | `ksql.limits.max_apps_per_cluster` | Clusters in one Confluent Cloud Kafka Cluster. |
  - `api_version` 'ksqldbcm/v2', required — APIVersion defines the schema version of this representation of a resource.
  - `kind` 'ClusterList', 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` 'ksqldbcm/v2' — APIVersion defines the schema version of this representation of a resource.
    - `kind` 'Cluster' — 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").
    - `metadata` object, required — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
      - `self` string, uri, required — Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time
      - `resource_name` string, uri — Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name
      - `created_at` string, date-time — The date and time at which this object was created. It is represented in RFC3339 format and is in UTC.
      - `updated_at` string, date-time — The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC.
      - `deleted_at` string, date-time — The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC.
    - `spec` object, required — The desired state of the Cluster
      - `display_name` string, required — The name of the ksqlDB cluster.
      - `use_detailed_processing_log` boolean — This flag controls whether you want to include the row data in the processing log topic. Turn it off if you don't want to emit sensitive information to the processing log
      - `csu` integer, required — The number of CSUs (Confluent Streaming Units) in a ksqlDB cluster.
      - `kafka_cluster` object, required — The kafka_cluster 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
      - `credential_identity` object, required — The credential_identity to which this belongs. The credential_identity can be one of iam.v2.User, iam.v2.ServiceAccount.
        - `id` string, required — ID of the referred resource
        - `related` string, uri, required — API URL for accessing or modifying the referred object
        - `resource_name` string, uri, required — CRN reference to the referred resource
        - `api_version` string — API group and version of the referred resource
        - `kind` string — Kind of the referred resource
      - `environment` object, required — The environment to which this belongs.
        - `id` string, required — ID of the referred resource
        - `related` string, uri, required — API URL for accessing or modifying the referred object
        - `resource_name` string, uri, required — CRN reference to the referred resource
    - `status` KsqldbcmV2ClusterStatus, required — The status of the Cluster
      - `http_endpoint` string — The dataplane endpoint of the ksqlDB cluster.
      - `phase` string, required — Status of the ksqlDB cluster.
      - `is_paused` boolean, required — Tells you if the cluster has been paused
      - `storage` integer, required — Amount of storage (in GB) provisioned to this cluster
      - `topic_prefix` string — Topic name prefix used by this ksqlDB cluster. Used to assign ACLs for this ksqlDB cluster to use.

## 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)