Skip to main content
GET
/
v1
/
vault
/
{key}
Get Credential
curl --request GET \
  --url https://api.bctrl.ai/v1/vault/{key} \
  --header 'Authorization: Bearer <token>'
{
  "username": "<string>",
  "password": "<string>",
  "totp": "<string>",
  "notes": "<string>"
}
key
string
required
Credential key (supports / separators for namespacing, e.g. aws/prod).
Returns null (SDK) or 404 (REST) if the key does not exist.

Examples

const vault = client.vault;
const cred = await vault.get('github');
console.log(cred.username);

Response

username
string
Username or identifier.
password
string
Password or secret.
totp
string
TOTP secret (if configured).
notes
string
Freeform notes.
Response Example
{
  "username": "bot@acme.com",
  "password": "s3cret"
}

Errors

CodeDescription
404Credential not found