List and view Kafka clusters

You can list all clusters in an environment or view details for a specific cluster, such as its type, capacity, and networking endpoints.

List clusters

You can list clusters using the Confluent Cloud Console, Confluent CLI, or REST API.

Cloud Console

From the Administration menu, select Environments.
Select an environment.

A list of clusters appears.

Confluent CLI

To list clusters using the CLI, run the following command in your terminal:

confluent kafka cluster list [flags]

For example:

confluent kafka cluster list

 Current |     ID     |    Name   |   Type   | Cloud |   Region  | Availability | Status
---------+------------+-----------+----------+-------+-----------+--------------+--------
         | lkc-123exc | cluster_1 | BASIC    | gcp   | us-west4  | single-zone  | UP
         | lkc-123exb | cluster_0 | STANDARD | gcp   | us-west4  | single-zone  | UP
         | lkc-123exa | cluster_2 | BASIC    | aws   | us-west-2 | single-zone  | UP

Confluent Cloud APIs

To list clusters, make a GET request that specifies the environment.

Request

GET /cmk/v2/clusters?environment={environment_id}

Your request can include the following parameters:

Parameter	Required or Optional	Description
`environment`	Required	Specifies the identifier for the environment that contains the clusters to list.
`page_size`	Optional	Specifies an integer page size for the returned payload. Max value is 100. Default: 10.
`spec.network`	Optional	A network identifier for the clusters to list. Your query can contain multiple network identifiers.
`page_token`	Optional	Contains the opaque pagination token string.

Response

Successful calls return HTTP 200 OK and a JSON payload that contains the list of clusters for the environment.

Responses include the following information:

The cloud provider (AWS, GCP, AZURE) and region for the cluster.
The cluster status (PROVISIONED, PROVISIONING, FAILED) and kind (Basic, Standard, Enterprise, Dedicated, and Freight).
Information about the environment that contains the cluster.
For Dedicated clusters, the number of CKUs allocated to the cluster.

Response examples by cluster type

Example responses for Dedicated clusters

On a secure public endpoint:

HTTP/1.1 200 OK
Content-Type: application/json

{
   "api_version": "cmk/v2",
   "data": [
      {
      "api_version": "cmk/v2",
      "kind": "Cluster",
      "id": "abc-f3a90de",
      "metadata": {
         "self": "https://api.confluent.cloud/v2/kafka-clusters/abc-f3a90de",
         "resource_name": "crn://confluent.cloud/kafka=abc-f3a90de",
         "created_at": "2022-04-22T20:45:26.657894Z",
         "updated_at": "2022-04-22T21:13:55.742641944Z"
      },
      "spec": {
         "display_name": "ProdKafkaCluster",
         "availability": "SINGLE_ZONE",
         "cloud": "GCP",
         "region": "us-east4",
         "config": {
               "kind": "Dedicated",
               "cku": 2
         },
         "kafka_bootstrap_endpoint": "abc-00000-00000.us-east4.gcp.glb.confluent.cloud:9092",
         "http_endpoint": "https://abc-00000-00000.us-east4.gcp.glb.confluent.cloud",
         "environment": {
            "id": "env-a12b34",
            "related": "https://api.confluent.cloud/v2/environments/env-a12b34",
            "resource_name": "crn://confluent.cloud/organization=1234abcd-edef-46ac-8a41-c49e44a3fd9a/environment=env-a12b34",
            "api_version": "org/v2",
            "kind": "Environment"
         }
      },
      "status": {
         "phase": "PROVISIONED",
         "cku": 2
      }
   }
   ],
   "kind": "ClusterList",
   "metadata": {
   "first": "https://api.confluent.cloud/cmk/v2/clusters",
   "total_size": 1
   }
}

In a private network:

HTTP/1.1 200 OK
Content-Type: application/json

{
   "api_version": "cmk/v2",
   "data": [
      {
      "api_version": "cmk/v2",
      "kind": "Cluster",
      "id": "abc-f3a90de",
      "metadata": {
         "self": "https://api.confluent.cloud/v2/kafka-clusters/abc-f3a90de",
         "resource_name": "crn://confluent.cloud/kafka=abc-f3a90de",
         "created_at": "2022-04-22T20:45:26.657894Z",
         "updated_at": "2022-04-22T21:13:55.742641944Z"
      },
      "spec": {
         "display_name": "ProdKafkaCluster",
         "availability": "SINGLE_ZONE",
         "cloud": "GCP",
         "region": "us-east4",
         "config": {
            "kind": "Dedicated",
            "cku": 2
            },
         "kafka_bootstrap_endpoint": "abc-00000-00000.us-east4.gcp.glb.confluent.cloud:9092",
         "http_endpoint": "https://abc-00000-00000.us-east4.gcp.glb.confluent.cloud",
         "environment": {
            "id": "env-a12b34",
            "related": "https://api.confluent.cloud/v2/environments/env-a12b34",
            "resource_name": "crn://confluent.cloud/organization=1234abcd-edef-46ac-8a41-c49e44a3fd9a/environment=env-a12b34",
            "api_version": "org/v2",
            "kind": "Environment"
            },
         "network": {
            "id": "n-00000",
            "environment": "env-a12b34",
            "related": "https://api.confluent.cloud/networking/v1/networks/n-00000",
            "resource_name": "crn://confluent.cloud/organization=1234abcd-edef-46ac-8a41-c49e44a3fd9a/network=n-00000",
            "api_version": "networking/v1",
            "kind": "Network"
            }
      },
      "status": {
         "phase": "PROVISIONED",
         "cku": 2
      }
   }
   ],
   "kind": "ClusterList",
   "metadata": {
   "first": "https://api.confluent.cloud/cmk/v2/clusters",
   "total_size": 1
   }
}

View cluster details

You can view details for a single cluster using the Confluent Cloud Console, Confluent CLI, or REST API.

For Enterprise clusters with both Private Network Interface and PrivateLink configured, you must initially assign a default endpoint. For more information, see Set the endpoint to be used by the Confluent Cloud Console for AWS Enterprise clusters.