Skip to main content
GET/vault/keys

List Keys

Returns the project's key-encryption key (KEK) versions.

Without status, only active keys are returned.

The list is complete, so nextCursor is always null.

Needs PROJECT_ADMIN or PROJECT_AUDITOR.

Parameters
projectId *query

The project's id.

statusquery

all returns every key, retired and revoked ones included.

Without it, only active keys.

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

Page of vault keys.

byokRefany
One of: null
or: object
externalKeyId *string

Provider-specific external key identifier (e.g., AWS KMS key ARN; GCP Cloud KMS resource path).

Example: "arn:aws:kms:eu-central-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
provider *string

BYOK provider slug — "aws-kms", "gcp-cloud-kms", "azure-key-vault", or "vault-transit".

Example: "aws-kms"
region *string

The project's region pin (byok_attachments.region): the platform region the key was attached for and is region-pinned against (a short code, e.g. us01).

The key's own provider location is inside external_key_id (the ARN or resource path).

Example: "de01"
createdAt *string <date-time>

Key creation timestamp.

Example: "2026-11-01T08:00:00.000Z"
custodyMode *"PLATFORM_MANAGED" | "CONFIDENTIAL_WORKLOAD" | "BYOK" | "HYOK"

Custody mode of a project's vault.

hyokRefany
One of: null
or: object
clusterId *string

Identifier of the HYOK cluster this key is scoped to.

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

Human-readable cluster name.

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

HSM-specific opaque key handle.

Example: "e3c5a2b1-7d4f-4a9e-b6c8-1f2e3d4c5b6a"
id *string

Key identifier — UUID prefixed "vkey_".

Example: "vkey_7Rt2Wq9LxP4m"
keyType *string

Key type — currently "AES-256-GCM-SIV" for all v2 data-encryption keys.

Example: "AES-256-GCM-SIV"
projectId *string

Project this key belongs to.

Example: "3f2b8c1e-5d4a-4e6f-9a7b-1c2d3e4f5a6b"
purpose *string

Key purpose. v2 customer-facing inventory keys serve data encryption only; the platform's ledger-signing key is platform-internal and not in this inventory.

Example: "data-encryption"
revokedAtstring <date-time> | null

Revocation timestamp; null unless status == "revoked".

Example: "2026-11-15T09:30:00.123Z"
rotatedAtstring <date-time> | null

Last successful rotation completion timestamp; null if never rotated.

Example: "2026-11-15T09:30:00.123Z"
status *"active" | "rotating" | "revoked"

Status of a vault key lifecycle (active | rotating | revoked).

version *integer <int64>

Monotone version scalar — starts at 1; incremented on each successful rotation.

Example: 3
nextCursorstring | null

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

Example: "eyJpZCI6InZrZXlfMDFIWlg0QTlCMkMzRDRFNUY2RzdIOEo5S00ifQ"
TypeScript
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.keys.list()

Showing example in TypeScript

Response example (200)
{
  "items": [
    {
      "createdAt": "2026-11-01T08:00:00.000Z",
      "custodyMode": "PLATFORM_MANAGED",
      "id": "vkey_7Rt2Wq9LxP4m",
      "keyType": "AES-256-GCM-SIV",
      "projectId": "3f2b8c1e-5d4a-4e6f-9a7b-1c2d3e4f5a6b",
      "purpose": "data-encryption",
      "revokedAt": "2026-11-15T09:30:00.123Z",
      "rotatedAt": "2026-11-15T09:30:00.123Z",
      "status": "active",
      "version": 3
    }
  ],
  "nextCursor": "eyJpZCI6InZrZXlfMDFIWlg0QTlCMkMzRDRFNUY2RzdIOEo5S00ifQ"
}

More in Keys