---
title: "Update Cluster"
method: PUT
path: "/v4/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId}"
tags: ["Clusters"]
---

# Update Cluster

`PUT /v4/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId}`

## Request

- Base URL: `https://cloudapi.cloud.couchbase.com`
- URL: `https://cloudapi.cloud.couchbase.com/v4/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/docs/v4/organizations/:organizationId/projects/:projectId/clusters/:clusterId/put.ts> (a function with typed inputs; its response is checked against the schema)

Updates an existing cluster.

In order to access this endpoint, the provided API key must have at least one of the following roles:
- Organization Owner
- Project Owner
- Project Manager

To learn more, see [Organization, Project, and Database Access Overview](https://docs.couchbase.com/cloud/organizations/organization-projects-overview.html).

## Headers

- `If-Match` string

## Request body

- UpdateClusterRequest
  - `name` string, required: The new name of the cluster (up to 256 characters).
  - `description` string, required: The new cluster description (up to 1024 characters).
  - `support` Support, required
    - `plan` 'basic' | 'developer pro' | 'enterprise', required: Plan type, either 'Basic', 'Developer Pro', or 'Enterprise'. Plan type allowed for singleNode cluster is either 'Basic', or 'Developer Pro'. In case of 'Basic' plan timezone field value is ignored.
    - `timezone` 'ET' | 'GMT' | 'IST' | 'PT': The standard timezone for the cluster. Should be the TZ identifier.
  - `serviceGroups` ServiceGroup[], required
    - `node` Node
      - `compute` Compute, required: Following are the supported compute combinations for CPU and RAM for different cloud providers. To learn more, see [Amazon Web Services](https://docs.couchbase.com/cloud/reference/aws.html).
        - `cpu` integer, required: CPU units (cores).
        - `ram` integer, required: RAM units (GB).
      - `disk` union, required
        - DiskAWS
          - `type` 'gp3' | 'io2', required: Type of disk. Please choose from the given list for AWS cloud provider.
          - `storage` integer, required: Storage in GB. See documentation for supported storage.
          - `iops` integer, required: Please refer to documentation for supported IOPS.
        - DiskAzure
          - `type` 'P6' | 'P10' | 'P15' | 'P20' | 'P30' | 'P40' | 'P50' | 'P60' | 'Ultra', required: Type of disk. Please choose from the given list for Azure cloud provider.
          - `storage` 64 | 128 | 256 | 512 | 1024 | 2048 | 3072 | 4096 | 5120 | 6144 | 7168 | 8192 | 9216 | 10240 | 11264 | 12288 | 13312 | 14336 | 15360: Storage in GB. Only required for Ultra Disk types. Not used in other storage types.
          - `iops` integer: Only required for Ultra Disk types. Not used in other storage types. See [IOPS Defaults](https://docs.couchbase.com/cloud/clusters/scale-database.html#IOPS-Defaults) for a list of supported IOPS values.
          - `autoExpansion` boolean: Determine if disk storage should automatically expand. Defaults to "true" if not specified.
        - DiskGCP
          - `type` 'pd-ssd', required: Type of disk. Please choose from the given list for GCP cloud provider.
          - `storage` integer, required: Storage in GB. Please refer to documentation for supported storage.
    - `numOfNodes` integer: Number of nodes. The minimum number of nodes for the cluster can be 3 and maximum can be 27 nodes. - Additional service groups can have 2 nodes minimum and 24 nodes maximum. - SingleNode cluster can have only 1 node.
    - `services` Service[]: The couchbase service to run on the node. The allowed services for singleNode cluster are one or all of - data, index, query and search.

## Response `204`

Successfully submitted request to update cluster.

## Other responses

- `403`: The client does not have the necessary permissions to access this resource.
- `404`: The requested resource was not found.
- `412`: Returned when there is a mismatch with the Etag version.
- `422`: Request validation error.
- `429`: Returned when the client exceeds the rate limit for the given APIKey.
- `500`: An unexpected error occurred in the server while processing this request.

---

[API](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api.md) - [All operations](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/revisions/a5e88bcf71cb?raw)