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
| Name | Type | Required | Notes |
|---|---|---|---|
| | yes | Project 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
| Error | Condition |
|---|---|
| API request failed |
| Network issue |
Pitfalls
- Values omitted — secret values are never returned in list responses; use
to retrieve individual valuesvault.get - Empty list — returns an empty
array when the project has no secrets (not an error)secrets
See also
{auto-injected}
Tested against
{auto-injected}