Skip to main content
GET/vault

Get Vault Status

Returns the project's custody mode, its active key, and the last custody change that completed.

Needs PROJECT_VIEWER.

Parameters
projectId *query

The project's id.

Responses
HTTPK9O CodeDescription
200The project's vault status.
401The request carries no authenticated caller.
404No such project, or its keys were destroyed.
500An internal error. Retry later.
Response body (200)
activeKeyIdstring | null

Identifier of the project's currently-active vault key (monotone scalar per F1; version field on the key entity surfaces the active version number).

Absent until the project is first keyed.

Example: "vkey_7Rt2Wq9LxP4m"
activeSincestring <date-time> | null

Timestamp the current custody mode became active (i.e., the most recent custody-mode-transition completion timestamp; or project creation time if no transition has occurred).

Absent until the project is first keyed.

Example: "2026-11-01T08:00:00.000Z"
attestationany
One of: null
or: object
lastAttestedAt *string <date-time>

Last successful re-attestation timestamp.

Example: "2026-11-15T09:30:00.123Z"
provider *string

Attestation provider — "sev-snp" or "tdx".

Example: "sev-snp"
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"
custodyMode *"PLATFORM_MANAGED" | "CONFIDENTIAL_WORKLOAD" | "BYOK" | "HYOK"

Custody mode of a project's vault.

hyokRefany
One of: null
or: object
clusterIdstring | null

Identifier of the HYOK cluster this project's keys are scoped to (org-level resource). null for a cloud-HSM provider (#5–#7, step 2b), which attaches a key directly, with no cluster.

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

HYOK provider, as stored (kibo_hyok::Provider::as_wire()): "kmip", "aws-kms-custom-key-store", "gcp-cloud-kms-hsm" or "azure-managed-hsm".

Example: "kmip"
lastCompletedJobany
One of: null
or: object
completedAt *string <date-time>

The database time of the completing transaction.

Example: "2026-11-15T09:30:00.123Z"
completedSeqinteger <int64> | null

The job's place in the project's completed-job order (null before 0060).

Example: 12
jobId *string

ctjob_<uuid>.

Example: "ctjob_7c9e6679-7425-40de-944b-e07fc1f90ae7"
restoreEpochstring | null

The fenceId of the last lifted restore episode (null if never restored), read in the same snapshot.

A change means sequence values were reissued: reset the watermark.

Example: "rfn_3Hk8Pz2Qw7Ln"
restoreGenerationinteger <int64> | null

The ordered restoreGeneration of that episode (the HWM its lift published to the witness): reset the watermark only for a GREATER generation. null if unknown.

Example: 2
toMode *"PLATFORM_MANAGED" | "CONFIDENTIAL_WORKLOAD" | "BYOK" | "HYOK"

Custody mode of a project's vault.

lastKeyRotationstring <date-time> | null

Last completed key rotation timestamp.

Example: "2026-11-15T09:30:00.123Z"
ledgerEventCount *integer <int64>

Total event count in the project's signed audit ledger.

Example: 1842
TypeScript
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.vault.status()

Showing example in TypeScript

Response example (200)
{
  "activeKeyId": "vkey_7Rt2Wq9LxP4m",
  "activeSince": "2026-11-01T08:00:00.000Z",
  "custodyMode": "PLATFORM_MANAGED",
  "lastKeyRotation": "2026-11-15T09:30:00.123Z",
  "ledgerEventCount": 1842
}