---
title: "GET /v2/GetClusterStatus"
method: GET
path: "/v2/GetClusterStatus"
tags: ["Cluster"]
---

# GET /v2/GetClusterStatus

`GET /v2/GetClusterStatus`

Returns the cluster's current status, including:

- ID of the node being queried and its version of the Garage daemon
- Live nodes
- Currently configured cluster layout
- Staged changes to the cluster layout

*Capacity is given in bytes*

## Response `200`

Cluster status report

- GetClusterStatusResponse
  - `layoutVersion` integer, required — Current version number of the cluster layout
  - `nodes` NodeResp[], required — List of nodes that are either currently connected, part of the current cluster layout, or part of an older cluster layout that is still active in the cluster (being drained).
    - `addr` string, nullable — Socket address used by other nodes to connect to this node for RPC
    - `dataPartition` FreeSpaceResp
      - `available` integer, required — Number of bytes available
      - `total` integer, required — Total number of bytes
    - `draining` boolean, required — Whether this node is part of an older layout version and is draining data.
    - `garageVersion` string, nullable — Garage version
    - `hostname` string, nullable — Hostname of the node
    - `id` string, required — Full-length node identifier
    - `isUp` boolean, required — Whether this node is connected in the cluster
    - `lastSeenSecsAgo` integer, nullable — For disconnected nodes, the number of seconds since last contact, or `null` if no contact was established since Garage restarted.
    - `metadataPartition` FreeSpaceResp
      - `available` integer, required — Number of bytes available
      - `total` integer, required — Total number of bytes
    - `role` NodeAssignedRole
      - `capacity` integer, nullable — Capacity (in bytes) assigned by the cluster administrator, absent for gateway nodes
      - `tags` string[], required — List of tags assigned by the cluster administrator
      - `zone` string, required — Zone name assigned by the cluster administrator

## Other responses

- `500` — Internal server error

---

[API](https://skmtc.dev/deuxfleurs/apis/garage-administration-api.md) · [All operations](https://skmtc.dev/deuxfleurs/apis/garage-administration-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/deuxfleurs/garage-administration-api/revisions/07ffb2d0febb/schema)