---
title: "Submit task to edit a cluster"
method: PUT
path: "/cluster"
tags: ["cluster"]
---

# Submit task to edit a cluster

`PUT /cluster`

Submit task to edit a Yugabyte Cluster

## Request body

- ClusterSpec — Cluster spec
  - `name` string, required — The name of the cluster
  - `cloud_info` CloudInfo, required — Cloud deployment information
    - `code` 'AWS' | 'GCP' | 'MANUAL', required — Which cloud the cluster is deployed in
    - `region` string, required
  - `cluster_info` ClusterInfo, required — Cluster level information
    - `num_nodes` integer, required — How many nodes are in the cluster
    - `fault_tolerance` 'NONE' | 'NODE' | 'ZONE' | 'REGION', required — The level of fault tolerance for the cluster
    - `node_info` ClusterNodeInfo, required — Node level information
      - `memory_mb` number, double, required — The total amount of RAM (MB) used by all nodes
      - `disk_size_gb` number, double, required — The total size of disk (GB)
      - `disk_size_used_gb` number, double — The total size of used disk space (GB)
      - `cpu_usage` number, double — The average CPU usage over all nodes
      - `num_cores` integer, required — The number of CPU cores per node
    - `is_production` boolean, required — Describes if the cluster is a production cluster
    - `version` integer, nullable — cluster data version
  - `cluster_region_info` ClusterRegionInfo[], nullable
    - `placement_info` PlacementInfo, required
      - `cloud_info` CloudInfo, required — Cloud deployment information
        - `code` 'AWS' | 'GCP' | 'MANUAL', required — Which cloud the cluster is deployed in
        - `region` string, required
      - `num_nodes` integer, required — How many nodes are in the region
  - `encryption_info` EncryptionInfo, required — Cluster encryption info
    - `encryption_at_rest` boolean
    - `encryption_in_transit` boolean

## Response `200`

Cluster response

- object
  - `data` ClusterData — Cluster data
    - `spec` ClusterSpec, required — Cluster spec
      - `name` string, required — The name of the cluster
      - `cloud_info` CloudInfo, required — Cloud deployment information
        - `code` 'AWS' | 'GCP' | 'MANUAL', required — Which cloud the cluster is deployed in
        - `region` string, required
      - `cluster_info` ClusterInfo, required — Cluster level information
        - `num_nodes` integer, required — How many nodes are in the cluster
        - `fault_tolerance` 'NONE' | 'NODE' | 'ZONE' | 'REGION', required — The level of fault tolerance for the cluster
        - `node_info` ClusterNodeInfo, required — Node level information
          - `memory_mb` number, double, required — The total amount of RAM (MB) used by all nodes
          - `disk_size_gb` number, double, required — The total size of disk (GB)
          - `disk_size_used_gb` number, double — The total size of used disk space (GB)
          - `cpu_usage` number, double — The average CPU usage over all nodes
          - `num_cores` integer, required — The number of CPU cores per node
        - `is_production` boolean, required — Describes if the cluster is a production cluster
        - `version` integer, nullable — cluster data version
      - `cluster_region_info` ClusterRegionInfo[], nullable
        - `placement_info` PlacementInfo, required
          - `cloud_info` CloudInfo, required — Cloud deployment information
            - `code` 'AWS' | 'GCP' | 'MANUAL', required — Which cloud the cluster is deployed in
            - `region` string, required
          - `num_nodes` integer, required — How many nodes are in the region
      - `encryption_info` EncryptionInfo, required — Cluster encryption info
        - `encryption_at_rest` boolean
        - `encryption_in_transit` boolean
    - `info` ClusterDataInfo, required
      - `id` string, uuid, required — The UUID of the cluster
      - `state` string, required — The current state of the cluster
      - `software_version` string — The current version of YugabyteDB installed on the cluster
      - `metadata` EntityMetadata, required — Common metadata for entities
        - `created_on` string, nullable — Timestamp when the entity was created (UTC)
        - `updated_on` string, nullable — Timestamp when the entity was last updated (UTC)

## Other responses

- `400` — API Error
- `500` — API Error

## Changes

- **2022-11-03** `237b718158ec` — 1 breaking, 7 info
  - the `data/spec/cluster_info/node_info/disk_size_gb` response's property type changed from `integer` to `number`, and format from no format to `double` for status `200`
  - added the new optional request property `cluster_info/node_info/disk_size_used_gb`
  - added the new required request property `cluster_info/node_info/num_cores` with a default value
  - the `disk_size_gb` request property default value changed from `256` to `0`
  - …4 more
- **2022-10-12** `2ef1f06f4ed0` — 4 breaking, 17 warning
  - removed the required property `data/info/project_id` from the response with the `200` status
  - removed the required property `data/spec/cluster_info/cluster_tier` from the response with the `200` status
  - removed the required property `data/spec/network_info` from the response with the `200` status
  - removed the required property `data/spec/software_info` from the response with the `200` status
  - …17 more
- **2022-07-06** `ae97ad3a2582` — 1 info
  - endpoint added
- **2022-06-13** `7856cb3301b2` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/yugabyte/apis/yugabyte-cloud/changes/cluster/put.md)

---

[API](https://skmtc.dev/yugabyte/apis/yugabyte-cloud.md) · [All operations](https://skmtc.dev/yugabyte/apis/yugabyte-cloud/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/yugabyte/yugabyte-cloud/revisions/237b718158ec/schema)