client.vault.get

Get a vault secret value.

Signature

class Client {
  vault: {
    get(projectId: string, name: string): Promise<{ name: string; value: string }>
  }
}

Parameters

projectId

string

name

string

Throws

NotFoundError

Examples

import { Client } from '@blueforge/client'
const bf = new Client({ apiKey: process.env.BF_API_KEY!, url: 'https://your-project.blueforge.dev' })
const { value } = await bf.vault.get('proj_abc', 'DATABASE_URL')

Pitfalls

• Sensitive output — avoid logging the returned value; consider using the secret directly in-memory without persisting to disk
• Case-sensitive — secret names are case-sensitive;

  DATABASE_URL

  and

  database_url

  are different secrets

See also

{auto-injected}

Tested against

{auto-injected}