# Get Summary

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

Returns the project's HYOK attachment for a region: the cluster it uses, the HSM model, and the key's KMIP id (`keyUid`). Needs `PROJECT_ADMIN` or `PROJECT_AUDITOR`.

## Parameters

| Name | In | Required | Description |
|---|---|---|---|
| `projectId` | query | yes | The project's id. Example: `"3f2c9a4e-8b1d-4c6f-9e2a-7d5b1c0a4e8f"`. |
| `region` | query | no | The region whose attachment to return. Without it, the project's home region. Example: `"de01"`. |

## Responses

- **200**: The HYOK attachment.

| Field | Type | Required | Description |
|---|---|---|---|
| `attestationTier` | string \| null | no | `provider-attested` or `kmip-manager-asserted`, as recorded at attach. Example: `"kmip-manager-asserted"`. |
| `clusterId` | string \| null | no | The KMIP cluster, within the project's org. `null` for a cloud-HSM provider (#5-#7). Example: `"hyokcluster_0b6f2c1e-3d4a-4b5c-8d9e-0f1a2b3c4d5e"`. |
| `hsmModel` | string \| null | no | `thales-luna`, `entrust-nshield` or `aws-cloudhsm`, when every host in the cluster names the same one. Example: `"thales-luna"`. |
| `keyUid` | string \| null | no | The customer key's KMIP unique identifier, as attached. Example: `"e3c5a2b1-7d4f-4a9e-b6c8-1f2e3d4c5b6a"`. |
| `region` | string \| null | no | The cluster's region code (`de01`). Example: `"de01"`. |


## Errors

| HTTP | Description |
|---|---|
| 401 | The request carries no authenticated caller. |
| 404 | The project has no HYOK attachment. |
| 500 | An internal error. Retry later. |

## Code samples

### cURL

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

### fetch

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