---
title: "Read a Cluster"
method: GET
path: "/srcm/v3/clusters/{id}"
tags: ["Clusters (srcm/v3)"]
---

# Read a Cluster

`GET /srcm/v3/clusters/{id}`

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

Make a request to read a cluster.

## Path parameters

- `id` string, required

## Query parameters

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

## Response `200`

Cluster.

- object — `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. The API allows you to list and read your Schema Registry clusters. Related guide: [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). ## The Clusters Model <SchemaDefinition schemaRef="#/components/schemas/srcm.v3.Cluster" />
  - `api_version` 'srcm/v3', required — APIVersion defines the schema version of this representation of a resource.
  - `kind` 'Cluster', required — 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 — 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 — The cluster name.
    - `package` string, required — The billing package. Note: Clusters can be upgraded from ESSENTIALS to ADVANCED, but cannot be downgraded from ADVANCED to ESSENTIALS.
    - `http_endpoint` string, uri — The cluster HTTP request URL.
    - `catalog_http_endpoint` string, uri — The cluster's catalog HTTP request URL.
    - `private_http_endpoint` string, uri — The cluster's private HTTP request URL. DEPRECATED - Please use the `private_networking_config.regional_endpoints` attribute instead, which supersedes the `private_http_endpoint` attribute.
    - `private_networking_config` object — Available HTTP request URLs for private connectivity.
      - `regional_endpoints` object — A map of region identifiers to their corresponding private HTTP request URL.
    - `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.
    - `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` SrcmV3ClusterStatus, 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

## 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
- `404` — Not Found
- `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)