BlueForge Docs

client.vault.list

List vault secrets for a project.

Signature

class Client {
  vault: {
    list(projectId: string): Promise<{ secrets: Array<{ name: string; createdAt: string | null; updatedAt: string | null }> }>
  }
}

Parameters

NameTypeRequiredNotes
projectId
string
yesProject ID

Examples

import { Client } from '@blueforge/client'
const bf = new Client({ apiKey: process.env.BF_API_KEY!, url: 'https://your-project.blueforge.dev' })
const { secrets } = await bf.vault.list('proj_abc')
for (const secret of secrets) {
  console.log(`${secret.name} (created: ${secret.createdAt})`)
}

Throws

ErrorCondition
ApiError
API request failed
NetworkError
Network issue

Pitfalls

  • Values omitted — secret values are never returned in list responses; use
    vault.get
    to retrieve individual values
  • Empty list — returns an empty
    secrets
    array when the project has no secrets (not an error)

See also

{auto-injected}

Tested against

{auto-injected}