Skip to main content
GET/vault/hyok

Get Summary

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
projectId *query

The project's id.

regionquery

The region whose attachment to return.

Without it, the project's home region.

Responses
HTTPK9O CodeDescription
200The HYOK attachment.
401The request carries no authenticated caller.
404The project has no HYOK attachment.
500An internal error. Retry later.
Response body (200)
attestationTierstring | null

provider-attested or kmip-manager-asserted, as recorded at attach.

Example: "kmip-manager-asserted"
clusterIdstring | null

The KMIP cluster, within the project's org. null for a cloud-HSM provider (#5-#7).

Example: "hyokcluster_0b6f2c1e-3d4a-4b5c-8d9e-0f1a2b3c4d5e"
hsmModelstring | null

thales-luna, entrust-nshield or aws-cloudhsm, when every host in the cluster names the same one.

Example: "thales-luna"
keyUidstring | null

The customer key's KMIP unique identifier, as attached.

Example: "e3c5a2b1-7d4f-4a9e-b6c8-1f2e3d4c5b6a"
regionstring | null

The cluster's region code (de01).

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

Showing example in cURL

Response example (200)
{
  "attestationTier": "kmip-manager-asserted",
  "clusterId": "hyokcluster_0b6f2c1e-3d4a-4b5c-8d9e-0f1a2b3c4d5e",
  "hsmModel": "thales-luna",
  "keyUid": "e3c5a2b1-7d4f-4a9e-b6c8-1f2e3d4c5b6a",
  "region": "de01"
}

More in HYOK Clusters & Hosts