Update a secret
PATCH
/api/secrets/{id}Personal API keyAgent API keyConsole session
Update a secret.
Authorization
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. How keys work.
Path parameters
idstringRequiredThe secret's id.
Request body
application/json · required
namestringOptional
at least 1 characterkeystringOptional
1–120 characterspattern: ^[a-zA-Z0-9_.-]+$statusstringOptional
one of: "active", "disabled", "archived", "deleted"providerConfigIdstring (uuid) | nullOptional
descriptionstring | nullOptional
externalRefstring | nullOptional
providerMetadataobject | nullOptional
Responses
200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
Errors return {"error": "..."}, often with a code and details. See errors and limits.