Sign in
Clusters (srcm/v3)

List of Clusters

General Availability

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

get/srcm/v3/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

Cluster.

api_version'srcm/v3' required

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

kind'ClusterList' required

Kind defines the object this REST resource represents.

Example response

{
  "metadata": {
    "first": "https://api.confluent.cloud/srcm/v3/clusters",
    "last": "https://api.confluent.cloud/srcm/v3/clusters?page_token=bcAOehAY8F16YD84Z1wT",
    "prev": "https://api.confluent.cloud/srcm/v3/clusters?page_token=YIXRY97wWYmwzrax4dld",
    "next": "https://api.confluent.cloud/srcm/v3/clusters?page_token=UvmDWOB1iwfAIBPj6EYb",
    "total_size": 123
  },
  "data": [
    {
      "id": "dlz-f3a90de",
      "metadata": {
        "self": "https://api.confluent.cloud/srcm/v3/clusters/lsrc-12345",
        "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lsrc-12345",
        "created_at": "2006-01-02T15:04:05-07:00",
        "updated_at": "2006-01-02T15:04:05-07:00",
        "deleted_at": "2006-01-02T15:04:05-07:00"
      },
      "spec": {
        "display_name": "Stream Governance package",
        "package": "ESSENTIALS",
        "http_endpoint": "https://psrc-00000.us-central1.gcp.confluent.cloud",
        "catalog_http_endpoint": "https://psrc-00000.us-central1.gcp.confluent.cloud",
        "private_http_endpoint": "https://lsrc-abc.us-central-1.aws.private.confluent.cloud",
        "private_networking_config": {
          "regional_endpoints": {
            "us-central-1": "https://lsrc-abc.us-central-1.aws.private.confluent.cloud",
            "us-west-2": "https://lsrc-abc.us-west-2.aws.private.confluent.cloud"
          }
        },
        "cloud": "GCP",
        "region": "us-east4",
        "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"
        }
      },
      "status": {
        "phase": "PROVISIONED"
      }
    }
  ]
}

Changes

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