# List Hosts

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

Returns the organisation's HYOK hosts, newest first. Without `status`, every host is returned, deregistered ones included. 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"`. |
| `status` | query | no | Return only hosts in this state: `registered`, `in_cluster` or `deregistered`. Example: `"in_cluster"`. |

## Responses

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

| Field | Type | Required | Description |
|---|---|---|---|
| `items` | array of object | yes | Page of HYOK hosts. |
| `items.[]caRef` | string | yes | Secret-store handle for the customer's server trust-anchor CA. Example: `"secret://hyok/kmip-server-ca"`. |
| `items.[]clientCertRef` | string | yes | Secret-store handle for the platform mTLS client identity. Example: `"secret://hyok/kmip-client-identity"`. |
| `items.[]clusterId` | string \| null | no | Cluster identifier; non-null iff `status == in_cluster`. Example: `"hyokcluster_0b6f2c1e-3d4a-4b5c-8d9e-0f1a2b3c4d5e"`. |
| `items.[]createdAt` | string (date-time) | yes | Host registration timestamp. Example: `"2026-11-01T08:00:00.000Z"`. |
| `items.[]hostname` | string | yes | KMIP manager hostname (matches the server-cert SAN). Example: `"kmip.acme.example"`. |
| `items.[]hsmModel` | enum ("thales-luna", "entrust-nshield", "aws-cloudhsm") | yes | HSM model variants supported in the HYOK host registry. |
| `items.[]id` | string | yes | Host identifier — UUID prefixed `"hyokhost_"`. Example: `"hyokhost_9e8d7c6b-5a49-4f3e-8d2c-1b0a9f8e7d6c"`. |
| `items.[]label` | string | yes | Human-readable label (e.g., `"luna-prod-01"`). Example: `"luna-prod-01"`. |
| `items.[]orgId` | string | yes | Owning org. Example: `"org_8kP3wQ9zLm2X"`. |
| `items.[]partitionLabel` | string \| null | no | PKCS#11-era partition label — retired for the KMIP single-host shape; present only on legacy rows. Example: `"partition-1"`. |
| `items.[]port` | integer (int32) | yes | KMIP manager port. Example: `5696`. |
| `items.[]protocolVersion` | string | yes | KMIP protocol version negotiated (floor `1.4`). Example: `"1.4"`. |
| `items.[]status` | enum ("registered", "in_cluster", "deregistered") | yes | HYOK host lifecycle status. |
| `nextCursor` | string \| null | no | Opaque cursor for the next page; `null` when this page is the last. Example: `"eyJpZCI6Imh5b2tob3N0XzAxSFpYMlQ0UjZZOFUwSTJPNFA2QThTMERGIn0"`. |


## 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/hosts' \
  -H 'Authorization: Bearer $K9O_TOKEN'
```

### fetch

```javascript
const res = await fetch('https://<org>.api-<region>.k9o.io/@storefront/vault/hyok/hosts', {
  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-hosts
