Retrieves the details of a single Vault by ID.
Prerequisites
Endpoint and authentication configured. For details, see Overview and authentication.
Endpoint
GET /vaults/{vault_id}
Path parameters
| Field | Required | Type | Description |
|---|---|---|---|
vault_id | Yes | string | Vault ID, format vlt_xxx |
Request example
Response example
Response fields
| Field | Type | Description |
|---|---|---|
id | string | Vault ID, format vlt_xxx |
type | string | Always vault |
display_name | string | Human-readable name of the Vault |
metadata | object | Custom key-value pairs |
archived_at | string | null | Archive timestamp; null if not archived |
created_at | string | Creation time, ISO 8601 |
updated_at | string | Last update time, ISO 8601 |
Error codes
| HTTP status | Error code | Description |
|---|---|---|
| 400 | InvalidParameter | Required parameter missing or invalid |
| 401 | InvalidApiKey | Invalid API key provided |