The Vault API provides create, query, update, archive, and delete operations for vault containers. A Vault is used to centrally store and manage Credentials.
Overview
A Vault is a container for Credentials, used to centrally store and manage secrets. Archiving is a soft operation: once archived_at is set, the Vault no longer appears in list results by default (unless include_archived=true is passed in the query), and Credentials in an archived Vault can still be used by sessions already bound to them. Deletion is a hard delete and cannot be undone; all Credentials inside the Vault are removed along with it.
Vault operations
| Operation | Endpoint | Description |
|---|---|---|
| Create Vault | POST /vaults | Create a Vault for centrally storing and managing Credentials |
| Get Vault | GET /vaults/{vault_id} | Get the details of a single Vault by ID |
| List Vaults | GET /vaults | Paginated list of Vaults under the workspace; archived items are excluded by default |
| Update Vault | POST /vaults/{vault_id} | Update the name or metadata using patch semantics |
| Archive Vault | POST /vaults/{vault_id}/archive | Soft archive; sessions already bound are unaffected |
| Delete Vault | DELETE /vaults/{vault_id} | Hard delete, cannot be undone; all Credentials in the Vault are removed |