Paginated list of Vaults under the workspace. Archived items are excluded by default.
Prerequisites
Endpoint and authentication configured. For details, see Overview and authentication.
Endpoint
GET /vaults
Query parameters
| Field | Required | Type | Description |
|---|---|---|---|
include_archived | No | boolean | Whether to include archived Vaults; default false |
limit | No | integer | Number of items per page; default 20, max 100 |
page | No | string | Pagination cursor; take from the next_page value of the previous response |
Request example
Response example
Response fields
| Field | Type | Description |
|---|---|---|
data | array<object> | Array of Vault objects |
data[].id | string | Vault ID, format vlt_xxx |
data[].type | string | Always vault |
data[].display_name | string | Human-readable name of the Vault |
data[].metadata | object | Custom key-value pairs |
data[].archived_at | string | null | Archive timestamp; null if not archived |
data[].created_at | string | Creation time, ISO 8601 |
data[].updated_at | string | Last update time, ISO 8601 |
next_page | string | null | Next page cursor; null when there is no more data |
Error codes
| HTTP status | Error code | Description |
|---|---|---|
| 400 | InvalidParameter | Required parameter missing or invalid |
| 401 | InvalidApiKey | Invalid API key provided |