---
title: "Get a cluster"
method: GET
path: "/cluster"
tags: ["cluster"]
---

# Get a cluster

`GET /cluster`

Get a Yugabyte Cluster

## 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
        - `replication_factor` integer — The replication factor applied on 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
          - `ram_provisioned_gb` number, double, required — The total size of provisioned ram (GB)
        - `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
      - `universe_uuid` string, uuid, required — The UUID of the universe
      - `cluster_uuid` 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

---

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