class HashiCorpVaultProvider
implements SecretProvider
Since 0.1.0

HashiCorp Vault (KV v2) provider.

Constructors

HashiCorpVaultProvider(options?: HashiCorpVaultProviderOptions)
Parameters

Vault connection/injection options

Methods

connect(): Promise<void>

Establishes any backing connection/client. No-op for stateless providers.

disconnect(): Promise<void>

Releases any backing connection/client. No-op for stateless providers.

get(name: string): Promise<string | null>

Reads a secret from Vault's KV v2 engine.

Since 0.5.0
isHealthy(): Promise<boolean>

Probes Vault's unauthenticated /v1/sys/health (M90b). Any HTTP response proves the server answered — Vault reports its standby and sealing states through STATUS CODES on this endpoint, all of which mean "reachable" — and a network failure does not. No secret is read and the auth token is not sent: the health endpoint is unauthenticated by design, and a read is not a probe.

isReady(): boolean

Reports whether the provider is ready to serve reads.

set(
name: string,
value: string
): Promise<void>

Writes a new secret version to Vault's KV v2 engine.

Usage

import { HashiCorpVaultProvider } from "secrets-plugin/src/index.ts";