List secrets

List Vault secret metadata. This Tool never returns usernames, passwords, values, or TOTP seeds.

List secrets

1
const result = await bctrl.tools.call("vault.secrets.list", {
2
  prefix: "production/",
3
  hasTotp: true,
4
  limit: 50,
5
});
6
7
for (const secret of result.secrets) {
8
  console.log(secret.name, secret.type, secret.hasTotp);
9
}

Secret names use slash-separated segments made from letters, numbers, ., _, ~, and -.

Request parameters

Response

The result is { secrets, nextCursor }:

The Space’s Vault access policy controls which secrets the caller can use. See Spaces for the allow and deny rules.

Next

• Get secret metadata — inspect one secret
• Set secret — create or replace a secret
• Spaces — configure Vault access