# Get Vault Status

`GET /vault` · Keys & Secrets · Vault

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

## Parameters

| Name | In | Required | Description |
|---|---|---|---|
| `projectId` | query | yes | The project's id. Example: `"3f2c9a4e-8b1d-4c6f-9e2a-7d5b1c0a4e8f"`. |

## Responses

- **200**: The project's vault status.

| Field | Type | Required | Description |
|---|---|---|---|
| `activeKeyId` | string \| null | no | 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"`. |
| `activeSince` | string (date-time) \| null | no | 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"`. |
| `attestation` | object | no |  |
| _one of_ | | |  |
| _or_ | | |  |
| `attestation.lastAttestedAt` | string (date-time) | yes | Last successful re-attestation timestamp. Example: `"2026-11-15T09:30:00.123Z"`. |
| `attestation.provider` | string | yes | Attestation provider — `"sev-snp"` or `"tdx"`. Example: `"sev-snp"`. |
| `byokRef` | object | no |  |
| _one of_ | | |  |
| _or_ | | |  |
| `byokRef.externalKeyId` | string | yes | 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"`. |
| `byokRef.provider` | string | yes | BYOK provider slug — `"aws-kms"`, `"gcp-cloud-kms"`, `"azure-key-vault"`, or `"vault-transit"`. Example: `"aws-kms"`. |
| `byokRef.region` | string | yes | 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` | enum ("PLATFORM_MANAGED", "CONFIDENTIAL_WORKLOAD", "BYOK", "HYOK") | yes | Custody mode of a project's vault. |
| `hyokRef` | object | no |  |
| _one of_ | | |  |
| _or_ | | |  |
| `hyokRef.clusterId` | string \| null | no | 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"`. |
| `hyokRef.provider` | string | yes | 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"`. |
| `lastCompletedJob` | object | no |  |
| _one of_ | | |  |
| _or_ | | |  |
| `lastCompletedJob.completedAt` | string (date-time) | yes | The database time of the completing transaction. Example: `"2026-11-15T09:30:00.123Z"`. |
| `lastCompletedJob.completedSeq` | integer (int64) \| null | no | The job's place in the project's completed-job order (null before 0060). Example: `12`. |
| `lastCompletedJob.jobId` | string | yes | `ctjob_<uuid>`. Example: `"ctjob_7c9e6679-7425-40de-944b-e07fc1f90ae7"`. |
| `lastCompletedJob.restoreEpoch` | string \| null | no | 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"`. |
| `lastCompletedJob.restoreGeneration` | integer (int64) \| null | no | 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`. |
| `lastCompletedJob.toMode` | enum ("PLATFORM_MANAGED", "CONFIDENTIAL_WORKLOAD", "BYOK", "HYOK") | yes | Custody mode of a project's vault. |
| `lastKeyRotation` | string (date-time) \| null | no | Last completed key rotation timestamp. Example: `"2026-11-15T09:30:00.123Z"`. |
| `ledgerEventCount` | integer (int64) | yes | Total event count in the project's signed audit ledger. Example: `1842`. |


## Errors

| HTTP | Description |
|---|---|
| 401 | The request carries no authenticated caller. |
| 404 | No such project, or its keys were destroyed. |
| 500 | An internal error. Retry later. |

## Code samples

### cURL

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

### fetch

```javascript
const res = await fetch('https://<org>.api-<region>.k9o.io/@storefront/vault', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.K9O_TOKEN}`
  },
});
const { data, meta } = await res.json();
```

### k9o CLI

```bash
k9o vault status
```

### @k9o/core

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

### k9o

```python
# k9o = create_client(org_slug="playground", project_slug="storefront", api_key="k9o_…")
response = k9o.vault.status()
```

### sdk-go

```go
// ctx := context.Background()
// client, _ := k9o.NewClient(k9o.ClientOpts{OrgSlug: "playground", ProjectSlug: "storefront", APIKey: "k9o_…"})
data, _, kerr := client.Vault.Status(ctx)
```

### k9o

```rust
// let k9o = Client::new(ClientOpts { org_slug: "playground".into(), project_slug: "storefront".into(), api_key: "k9o_…".into() })?;
let resp = k9o.vault().status().await?;
```

### dev.k9o:core

```java
// K9o k9o = K9o.createClient(K9o.Opts.builder().orgSlug("playground").projectSlug("storefront").apiKey("k9o_…").build());
var response = k9o.vault().status()
```

### K9o.Core

```c#
// var k9o = K9oClient.Create(new K9oOptions { OrgSlug = "playground", ProjectSlug = "storefront", ApiKey = "k9o_…" });
var response = await k9o.Vault.StatusAsync()
```

### k9o

```ruby
# k9o = K9o.create_client(org_slug: "playground", project_slug: "storefront", api_key: "k9o_…")
response = k9o.vault.status()
```

### k9o/sdk

```php
// $k9o = K9oClient::create(['org_slug' => 'playground', 'project_slug' => 'storefront', 'api_key' => 'k9o_…']);
$response = $k9o->vault->status()
```


Canonical page: https://docs.kilimanjaro.dev/api-playground/keys-secrets/get-vault-status
