---
title: "Get a cluster"
method: GET
path: "/clusters/{cluster_id}"
tags: ["Support API Key Authentication"]
---

# Get a cluster

`GET /clusters/{cluster_id}`

## Request

- Base URL: `https://lium.io/api`
- URL: `https://lium.io/api/clusters/{cluster_id}`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Whether every node of a cluster rental started. `status` is PROVISIONING while its nodes are being rented, then STARTING until every node has started once (RUNNING; a node's later reboot or failure does not change it). If a node fails or misses the 20-minute start deadline, every node is deleted (ROLLING_BACK, then ROLLED_BACK) and `member_failures` names the nodes that failed. DELETING and DELETED follow a cluster delete. Readable after the member pods are gone.

## Path parameters

- `cluster_id` string, uuid, required

## Response `200`

The cluster's start outcome and its member pods

- ClusterStatusResponse
  - `cluster_id` string, uuid, required
  - `status` string, required
  - `node_count` integer, required
  - `start_deadline_at` string, date-time, required
  - `member_failures` ClusterMemberFailure[], required
    - `pod_id` string, uuid, nullable
    - `node_index` integer, required
    - `status` string, nullable
    - `reason` string, required
  - `pods` ClusterMemberStatus[], required
    - `pod_id` string, uuid, required
    - `pod_name` string, nullable
    - `cluster_node_index` integer, nullable
    - `status` string, required

## Other responses

- `404`: Cluster not found
- `422`: Validation Error

## Changes

- **2026-10-27** `cac19826b0ec`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/lium/apis/lium-backend-api/changes/clusters/:cluster_id/get.md)

---

[API](https://skmtc.dev/lium/apis/lium-backend-api.md) - [All operations](https://skmtc.dev/lium/apis/lium-backend-api/llms.txt) - [OpenAPI document](https://skmtc.dev/lium/apis/lium-backend-api/revisions/3cc1a86a2b07?raw)
