Skip to main content
PATCH
Update a credential

Authorizations

Authorization
string
header
required

Agent token (alt_…) or OAuth access token; bound to one agent

Path Parameters

itemId
string
required

Credential id (vlt_…)

Body

application/json
name
string
Required string length: 1 - 120
username
string

Account email or username; use the agent's own address for new accounts

Maximum string length: 320
secret
string

Password or API key. Omit for a login to have a strong password generated

Maximum string length: 16384
generate
boolean

Generate a new strong password (logins only); the value is returned once as generated_secret

allowed_origins
string[]

Exact HTTPS origins where this credential may be used, e.g. https://accounts.example.com

Maximum array length: 20
Maximum string length: 2048
agent_readable
boolean

Whether this agent may read the value through get_credential (default true for agent-created items)

totp
string

Authenticator secret: an otpauth://totp/... URI or the base32 key shown by the website. Empty string removes it

Maximum string length: 2048
notes
string

Recovery codes or other account notes (≤ 4 KB)

Maximum string length: 4096

Response

Credential

credential
object
required

Credential metadata; values are never part of it.

generated_secret
string

A generated password, returned once