Skip to main content
GET/vault/hyok/clusters

List Clusters

Returns the organisation's HYOK clusters.

The list is complete, so nextCursor is always null.

Needs ORG_ADMIN.

Parameters
orgId *query

The organisation's id.

Responses
HTTPK9O CodeDescription
200The organisation's clusters.
401The request carries no authenticated caller.
500An internal error. Retry later.
Response body (200)
items *object[]

Page of HYOK clusters.

attachedProjectIds *string[]

Project IDs currently in HYOK mode using this cluster.

createdAt *string <date-time>

Cluster creation timestamp.

Example: "2026-11-01T08:00:00.000Z"
hostIds *string[]

IDs of hosts in this cluster.

id *string

Cluster identifier — UUID prefixed "hyokcluster_".

Example: "hyokcluster_0b6f2c1e-3d4a-4b5c-8d9e-0f1a2b3c4d5e"
name *string

Human-readable cluster name.

Example: "luna-prod-eu"
orgId *string

Owning org.

Example: "org_8kP3wQ9zLm2X"
region *string

Region — must match the Kibo project's region pin at attach time.

Example: "de01"
status *"active" | "warning" | "degraded" | "inactive"

HYOK cluster operational status.

nextCursorstring | null

Opaque cursor for the next page; null when this page is the last.

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

Showing example in cURL

Response example (200)
{
  "items": [
    {
      "attachedProjectIds": [
        "3f2b8c1e-5d4a-4e6f-9a7b-1c2d3e4f5a6b"
      ],
      "createdAt": "2026-11-01T08:00:00.000Z",
      "hostIds": [
        "hyokhost_9e8d7c6b-5a49-4f3e-8d2c-1b0a9f8e7d6c"
      ],
      "id": "hyokcluster_0b6f2c1e-3d4a-4b5c-8d9e-0f1a2b3c4d5e",
      "name": "luna-prod-eu",
      "orgId": "org_8kP3wQ9zLm2X",
      "region": "de01",
      "status": "active"
    }
  ],
  "nextCursor": "eyJpZCI6Imh5b2tjbHVzdGVyXzAxSFpYM1Y4TTJLOVE0VDdXNlk1UjFOMEJDIn0"
}

More in HYOK Clusters & Hosts