---
title: "Get Cluster Health"
method: GET
path: "/api/v3/byoc/clusters/{cluster_id}/status"
tags: ["BYOC"]
---

# Get Cluster Health

`GET /api/v3/byoc/clusters/{cluster_id}/status`

## Request

- Base URL: `https://api.nugen.in`
- URL: `https://api.nugen.in/api/v3/byoc/clusters/{cluster_id}/status`
- Auth: HTTP bearer

Provisioning progress and health for one environment.


**Path Parameters:**

- `cluster_id`: The environment to check


**Returns:**

- `cluster_id`, `cluster_name`, `mode`
- `status`: Provisioning status
- `message`: What the status means
- `created_at`: When the request was received


**Raises:**

- `404`: If the environment is not found or does not belong to you

## Path parameters

- `cluster_id` string, required

## Response `200`

Current status of a bring your own cloud environment.

- ByocClusterStatusResponse: Provisioning progress and cluster health.
  - `cluster_id` string, required: Identifier of this environment.
  - `cluster_name` string, required: Name given to the environment.
  - `mode` 'managed_provisioning' | 'cluster_import', required: managed_provisioning or cluster_import.
  - `status` string, required: Provisioning status.
  - `message` string, required: Human-readable status detail.
  - `created_at` string, date-time, nullable: When the request was received.

## Other responses

- `401`: Invalid API key
- `403`: Authorization header missing or not a Bearer token
- `404`: Resource not found
- `422`: Validation Error

---

[API](https://skmtc.dev/nugen/apis/nugen-intelligence-api.md) - [All operations](https://skmtc.dev/nugen/apis/nugen-intelligence-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nugen/apis/nugen-intelligence-api/revisions/62baa7960a4a?raw)