Skip to main content
GET
Check health
Probes the provider behind a vault config to confirm the stored token still works. Use it before a run that depends on the vault, since a token can be revoked or expire on the provider side. The endpoint returns 200 whenever the provider is reachable, so branch on the ok field, not the HTTP status. Returns a health object with ok and an optional error.

Path parameters

vault_id
string
required
The vault config’s id (UUID).

Response

ok
boolean
true if the provider accepted the stored token and the vault is reachable.
error
string | null
Short reason when ok is false; null otherwise.

Examples

Response

Errors