Delete secret

View as Markdown

Delete one Vault secret by name. Deletion is permanent for the named secret.

Delete a secret

1const result = await bctrl.tools.call("vault.secrets.delete", {
2 name: "production/github/api-token",
3});
4
5console.log(result.name, result.deleted); // true

Inspect metadata with Get secret metadata or List secrets before deleting.

Request parameters

ParameterTypeRequiredDescription
nameVaultSecretNameYesSecret name made from slash-separated letters, numbers, ., _, ~, and - segments. Maximum 256 characters.

Response

FieldTypeAlways presentDescription
nameVaultSecretNameYesDeleted secret name.
deletedtrueYesConfirms deletion.

Next