Forward API reference.
Vault object
Create, get, list, and archive endpoints return this structure.
| Field | Type | Description |
|---|---|---|
id | string | Vault ID with the vault_ prefix |
type | string | Always "vault" |
display_name | string | Vault display name, at most 255 characters |
metadata | object | Custom metadata stored with the Vault; defaults to {} when omitted. created_by is reserved by Forward and must not be supplied by callers |
archived_at | string | null | Archive time in RFC 3339 format; null while active |
created_at | string | Creation time in RFC 3339 format |
updated_at | string | Last update time in RFC 3339 format |
identity_id | string | null | Owning Forward identity; typically null when created with a PAT |
icon_url | string | null | Icon URL associated by Forward |
binding_info | Binding info | Binding information, such as Template reference counts |
Binding info
Reference summary included by Forward in Vault responses.
| Field | Type | Description |
|---|---|---|
agent_template_count | integer | Number of Templates currently bound to the Vault |
List pagination fields
| Field | Type | Description |
|---|---|---|
data | array of Vault objects | Records on the current page |
has_more | boolean | Whether another page is available |
next_page | string | null | Forward cursor for the next page (recommended). Equals the current page's last_id when has_more=true; otherwise null |
first_id | string | null | ID of the first record on the current page |
last_id | string | null | ID of the last record on the current page |
page, after_id, and before_id are mutually exclusive; providing more than one returns 400. Use page where possible; it has the same semantics as after_id.