---
title: "Get the nodes for a cluster"
method: GET
path: "/nodes"
tags: ["cluster-info"]
---

# Get the nodes for a cluster

`GET /nodes`

Get nodes for a Yugabyte cluster

## Response `200`

Cluster nodes response

- object
  - `data` NodeData[], required
    - `name` string, required
    - `host` string, required
    - `is_node_up` boolean, required
    - `is_master` boolean, required
    - `is_tserver` boolean, required
    - `is_read_replica` boolean, required
    - `preference_order` integer
    - `is_master_up` boolean, required
    - `is_bootstrapping` boolean, required
    - `metrics` object, required
      - `memory_used_bytes` integer, required
      - `total_sst_file_size_bytes` integer, nullable, required
      - `uncompressed_sst_file_size_bytes` integer, nullable, required
      - `read_ops_per_sec` number, double, required
      - `write_ops_per_sec` number, double, required
      - `time_since_hb_sec` number, double, required
      - `uptime_seconds` integer, required
      - `user_tablets_total` integer, required
      - `user_tablets_leaders` integer, required
      - `system_tablets_total` integer, required
      - `system_tablets_leaders` integer, required
      - `active_connections` object, required
        - `ysql` integer, required
        - `ycql` integer, required
      - `master_uptime_us` integer, required
      - `ram_used_bytes` integer, required
      - `ram_provisioned_bytes` integer, required
      - `disk_provisioned_bytes` integer, required
    - `cloud_info` object, required
      - `cloud` string
      - `region` string, required
      - `zone` string, required
    - `software_version` string, required

## Other responses

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

## Changes

> 45 revisions in range; 1 could not be searched.

- **2024-01-23** `84316cd7b5df` — 1 info
  - added the new optional `query` request parameter `get_all_masters` to all path's operations
- **2023-10-03** `bd9a1ea30534` — 1 info
  - added the optional property `data/items/preference_order` to the response with the `200` status
- **2023-05-18** `d32716222674` — 1 info
  - added the required property `data/items/is_read_replica` to the response with the `200` status
- **2022-12-21** `a0bb828aa483` — 14 info
  - added the required property `data/items/host` to the response with the `200` status
  - added the required property `data/items/is_bootstrapping` to the response with the `200` status
  - added the required property `data/items/is_master_up` to the response with the `200` status
  - added the required property `data/items/metrics/active_connections` to the response with the `200` status
  - …10 more
- **2022-08-29** `f8f0303db4f2` — 2 info
  - added the optional property `data/items/cloud_info/cloud` to the response with the `200` status
  - added the required property `data/items/software_version` to the response with the `200` status

[Full history](https://skmtc.dev/yugabyte/apis/yugabyte-cloud/changes/nodes/get.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/a851ee3a0a88/schema)