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.

Headers

x-tenant-id
string

Optional tenant consistency check. When present, it must name the tenant bound to the API key, including when x-organization-id is default.

Minimum string length: 1
x-organization-id
string

Organization in which to act. Required for a tenant-scoped API key. Optional for an organization-scoped key, where it must name that same organization. The value may be an organization id or default.

Minimum string length: 1

Path Parameters

vaultId
string<uuid>
required

Vault id (UUID) as returned by managedAgentsCreateVault or managedAgentsListVaults.

Body

application/json
displayName
string

Replacement operator-facing label. Omit to keep the current one; a blank or null value is rejected.

Maximum string length: 256
Pattern: \S
metadata
object

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

Response

OK

createdAt
string<date-time>
required
read-only

RFC 3339 timestamp of creation.

credentialCount
integer
required
read-only

How many credentials this vault currently holds.

Required range: -9007199254740991 <= x <= 9007199254740991
displayName
string
required

Operator-facing label for the vault.

organizationId
string
required
read-only

Organization that owns this record. Resolved from the authenticated principal; never accepted from the caller.

updatedAt
string<date-time>
required
read-only

RFC 3339 timestamp of the last change.

vaultId
string
required
read-only

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

metadata
object

Free-form caller-supplied key/value labels.