Справочник API публикуется на английском языке.
Update a secret
PATCH
/api/secrets/{id}Personal API keyAgent API keyConsole session
Update a secret.
Авторизация
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. Как работают ключи.
Параметры пути
idstringОбязательныйThe secret's id.
Тело запроса
application/json · обязательно
namestringНеобязательный
at least 1 characterkeystringНеобязательный
1–120 characterspattern: ^[a-zA-Z0-9_.-]+$statusstringНеобязательный
one of: "active", "disabled", "archived", "deleted"providerConfigIdstring (uuid) | nullНеобязательный
descriptionstring | nullНеобязательный
externalRefstring | nullНеобязательный
providerMetadataobject | nullНеобязательный
Ответы
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.
Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.