Rotate my user secret value

POST/api/companies/{companyId}/me/user-secrets/{secretId}/rotate
Personal API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Rotate my user secret value.

Authorization

Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. How keys work.

Path parameters

companyIdstringRequiredThe organization's id.
secretIdstringRequiredThe secret's id.

Request body

application/json · required

valuestring | nullOptionalat least 1 character
externalRefstring | nullOptionalat least 1 character
providerVersionRefstring | nullOptionalat least 1 character
providerConfigIdstring (uuid) | 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.

Secrets