Check vault health

Check that a vault’s stored token still works before a session needs it.

GET /api/v2/vaults/{vault_id}/health

Python

from hai_agents import Client

client = Client()

health = client.vaults.vault_health(vault_id=vault_id)
if not health.ok:
    print("vault unhealthy:", health.error)

200

{
  "ok": true,
  "error": null
}

Behavior

The endpoint returns 200 even when the provider is unreachable, so branch on the ok field, not the HTTP status. An H-hosted vault has no external provider and always reports ok: true.

Path parameters

vault_id · string · required

The vault config’s id (UUID).

Response

200 with the health result.

ok · boolean

true if the provider accepted the stored token and the vault is reachable.

error · string | null

Short reason when ok is false, otherwise null.

Python

from hai_agents import Client

client = Client()

health = client.vaults.vault_health(vault_id=vault_id)
if not health.ok:
    print("vault unhealthy:", health.error)

200

{
  "ok": true,
  "error": null
}

Errors

Status	Cause
404	Not found, or not in your organization.