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

# List of Clusters

`GET /cmk/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
- `spec.network` string[] — Filter a collection by a string search for one or more values
- `page_size` integer
- `page_token` string

## Response `200`

Cluster.

- object — `Clusters` objects represent Apache Kafka Clusters on Confluent Cloud. The API allows you to list, create, read, update, and delete your Kafka clusters. Related guide: [Confluent Cloud Cluster Management for Apache Kafka APIs](https://docs.confluent.io/cloud/current/clusters/cluster-api.html). ## The Clusters Model <SchemaDefinition schemaRef="#/components/schemas/cmk.v2.Cluster" /> ## Quotas and Limits This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): | Quota | Description | | --- | --- | | `kafka_clusters_per_environment` | Number of clusters in one Confluent Cloud environment |
  - `api_version` 'cmk/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` 'cmk/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 cluster.
      - `availability` string, required — The availability zone configuration of the cluster
      - `cloud` string, required — The cloud service provider in which the cluster is running.
      - `region` string, required — The cloud service provider region where the cluster is running.
      - `config` union, required — The configuration of the Kafka cluster. Note: Clusters can be upgraded from Basic to Standard, but cannot be downgraded from Standard to Basic.
        - CmkV2Basic — The basic cluster type.
          - `kind` 'Basic', required — Basic cluster type.
          - `max_ecku` integer — The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. For more details, see [Maximum eCKU requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements).
        - CmkV2Standard — The standard cluster type.
          - `kind` 'Standard', required — Standard cluster type.
          - `max_ecku` integer — The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with `HIGH` availability must have at least two eCKUs. For more details, see [Maximum eCKU requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements).
        - CmkV2Dedicated — A dedicated cluster with its parameters.
          - `kind` 'Dedicated', required — Dedicated cluster type.
          - `cku` integer, required — The number of Confluent Kafka Units (CKUs) for Dedicated cluster types. MULTI_ZONE dedicated clusters must have at least two CKUs.
          - `encryption_key` string — The id of the encryption key that is used to encrypt the data in the Kafka cluster. (e.g. for Amazon Web Services, the Amazon Resource Name of the key).
          - `zones` string[] — The list of zones the cluster is in. On AWS, zones are AWS [AZ IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html) (e.g. use1-az3) On GCP, zones are GCP [zones](https://cloud.google.com/compute/docs/regions-zones) (e.g. us-central1-c).
          - `release_priority` string — Specifies the release priority for cluster updates. Defaults to REGULAR. Clusters with PRIORITY are updated before clusters with REGULAR.
        - CmkV2Enterprise — The enterprise cluster type.
          - `kind` 'Enterprise', required — Enterprise cluster type.
          - `max_ecku` integer — The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with `HIGH` availability must have at least two eCKUs. For more details, see [Maximum eCKU requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements).
        - CmkV2Freight — A freight cluster with its parameters.
          - `kind` 'Freight', required — Freight cluster type.
          - `max_ecku` integer — The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with `HIGH` availability must have at least two eCKUs. For more details, see [Maximum eCKU requirements](https://docs.confluent.io/cloud/current/clusters/cluster-types.html#minimum-maximum-ecku-requirements).
          - `zones` string[] — The list of zones the cluster is in. On AWS, zones are AWS [AZ IDs](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html) (e.g. use1-az3) On GCP, zones are GCP [zones](https://cloud.google.com/compute/docs/regions-zones) (e.g. us-central1-c).
      - `kafka_bootstrap_endpoint` string — The bootstrap endpoint used by Kafka clients to connect to the cluster. DEPRECATED - Please use the `endpoints` attribute instead.
      - `http_endpoint` string, uri — The cluster HTTP request URL. DEPRECATED - Please use the `endpoints` attribute instead.
      - `api_endpoint` string — The Kafka API cluster endpoint used by Kafka clients to connect to the cluster. DEPRECATED - Please use the `endpoints` attribute instead.
      - `endpoints` CmkV2EndpointsMap — Map of endpoints for a Kafka cluster, keyed by access point ID.
      - `deletion_protection` boolean — Enable deletion protection for the cluster
      - `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
      - `network` object — The network associated with this object.
        - `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
      - `byok` object — Note: For Pre-BYOK v1 clusters, API responses might show both `encryption_key` and `byok`. To manage Pre-BYOK v1 keys, refer to: https://docs.confluent.io/cloud/current/security/encrypt/byok/legacy-byok.html #manage-pre-byok-api-v1-self-managed-encryption-keys
        - `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` CmkV2ClusterStatus, required — The status of the Cluster
      - `phase` string, required — The lifecyle phase of the cluster: PROVISIONED: cluster is provisioned; PROVISIONING: cluster provisioning is in progress; FAILED: provisioning failed
      - `cku` integer — The number of Confluent Kafka Units (CKUs) the Dedicated cluster currently has.

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