# List Clusters

`GET /vault/hyok/clusters` · Keys & Secrets · HYOK Clusters & Hosts

Returns the organisation's HYOK clusters. The list is complete, so `nextCursor` is always null. Needs `ORG_ADMIN`.

## Parameters

| Name | In | Required | Description |
|---|---|---|---|
| `orgId` | query | yes | The organisation's id. Example: `"org_O3QAqchb6v7d"`. |

## Responses

- **200**: The organisation's clusters.

| Field | Type | Required | Description |
|---|---|---|---|
| `items` | array of object | yes | Page of HYOK clusters. |
| `items.[]attachedProjectIds` | array of string | yes | Project IDs currently in HYOK mode using this cluster. Example: `["3f2b8c1e-5d4a-4e6f-9a7b-1c2d3e4f5a6b"]`. |
| `items.[]createdAt` | string (date-time) | yes | Cluster creation timestamp. Example: `"2026-11-01T08:00:00.000Z"`. |
| `items.[]hostIds` | array of string | yes | IDs of hosts in this cluster. Example: `["hyokhost_9e8d7c6b-5a49-4f3e-8d2c-1b0a9f8e7d6c"]`. |
| `items.[]id` | string | yes | Cluster identifier — UUID prefixed `"hyokcluster_"`. Example: `"hyokcluster_0b6f2c1e-3d4a-4b5c-8d9e-0f1a2b3c4d5e"`. |
| `items.[]name` | string | yes | Human-readable cluster name. Example: `"luna-prod-eu"`. |
| `items.[]orgId` | string | yes | Owning org. Example: `"org_8kP3wQ9zLm2X"`. |
| `items.[]region` | string | yes | Region — must match the Kibo project's region pin at attach time. Example: `"de01"`. |
| `items.[]status` | enum ("active", "warning", "degraded", "inactive") | yes | HYOK cluster operational status. |
| `nextCursor` | string \| null | no | Opaque cursor for the next page; `null` when this page is the last. Example: `"eyJpZCI6Imh5b2tjbHVzdGVyXzAxSFpYM1Y4TTJLOVE0VDdXNlk1UjFOMEJDIn0"`. |


## Errors

| HTTP | Description |
|---|---|
| 401 | The request carries no authenticated caller. |
| 500 | An internal error. Retry later. |

## Code samples

### cURL

```bash
curl -X GET 'https://<org>.api-<region>.k9o.io/@storefront/vault/hyok/clusters' \
  -H 'Authorization: Bearer $K9O_TOKEN'
```

### fetch

```javascript
const res = await fetch('https://<org>.api-<region>.k9o.io/@storefront/vault/hyok/clusters', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.K9O_TOKEN}`
  },
});
const { data, meta } = await res.json();
```


Canonical page: https://docs.kilimanjaro.dev/api-playground/keys-secrets/list-clusters
