Skip to main content
PATCH
Rename a vault or replace its metadata

Authorizations

Authorization
string
header
required

A Recursion API key, created in the console under API keys.

Path Parameters

vault_id
string<uuid>
required

Vault id (UUID) as returned by createVault or listVaults.

Body

application/json

Request body for updating a vault's label or metadata. Every field is optional; omitted fields keep their current value.

display_name
string

Replacement operator-facing label. Omit to keep the current one.

metadata
object

Replacement free-form caller-owned JSON. Sent as a whole object, not merged; omit to keep the current value.

Response

A named group of credentials an agent session may be granted. A session references vaults by id; the credential values inside are resolved at execution time and are never returned over the API.

A named group of credentials an agent session may be granted. A session references vaults by id; the credential values inside are resolved at execution time and are never returned over the API.

created_at
string<date-time>
required

RFC 3339 timestamp of when this record was created. Server-assigned.

credential_count
integer
required

How many credentials this vault currently holds, so a list view need not fetch each vault's credentials.

display_name
string
required

Operator-facing label for the vault, shown wherever vaults are listed.

organization_id
string
required

Organization that owns this record. Resolved from the API key; never accepted from the caller.

updated_at
string<date-time>
required

RFC 3339 timestamp of the last change to this record. Server-assigned.

vault_id
string
required

Identifier for this vault (UUID). Server-assigned.

metadata
object

Free-form caller-supplied key/value labels. Stored verbatim and never interpreted by the service.