---
title: "Update a Cluster"
method: PATCH
path: "/srcm/v2/clusters/{id}"
tags: ["Clusters (srcm/v2)"]
deprecated: true
---
# Update a Cluster
`PATCH /srcm/v2/clusters/{id}`
> **Deprecated.**
[](#section/Versioning/API-Lifecycle-Policy)
Make a request to update a cluster.
## Path parameters
- `id` string, required
## Request body
- object — `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. The API allows you to list, create, read, and delete your Schema Registry clusters. Related guides: * [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). * [srcm/v3 Migration Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). ## The Clusters Model
- `api_version` 'srcm/v2' — APIVersion defines the schema version of this representation of a resource.
- `kind` 'Cluster' — Kind defines the object this REST resource represents.
- `id` string — 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 — 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.
- `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
- `region` GlobalObjectReference — ObjectReference provides information for you to locate the referred object
- `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` SrcmV2ClusterStatus — 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 Note: Schema Registry Cluster Management is handled through the org/v2 Environments API as of srcm/v3.
## Response `200`
Cluster.
- object — `Clusters` objects represent Schema Registry Clusters on Confluent Cloud. The API allows you to list, create, read, and delete your Schema Registry clusters. Related guides: * [Confluent Cloud Schema Registry Cluster APIs](https://docs.confluent.io/cloud/current/stream-governance/clusters-regions-api.html#schema-registry-cluster-management). * [srcm/v3 Migration Guide](https://docs.confluent.io/cloud/current/stream-governance/packages.html#deprecation-of-srcm-v2-clusters-and-regions-apis-and-upgrade-guide). ## The Clusters Model
- `api_version` 'srcm/v2', 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.
- `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
- `region` object, required — The region 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` SrcmV2ClusterStatus, 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 Note: Schema Registry Cluster Management is handled through the org/v2 Environments API as of srcm/v3.
## 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
- `409` — The request is in conflict with the current server state
- `422` — Validation Failed
- `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)