Справочник API публикуется на английском языке.
Create a named personal API key
POST
/api/board-api-keysPersonal API keyConsole session
Create a named personal API key.
Авторизация
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. Как работают ключи.
Тело запроса
application/json · обязательно
namestringНеобязательный
1–120 charactersexpiresAtstring (date-time) | nullНеобязательный
requestedCompanyIdstring (uuid) | nullНеобязательный
Ответы
201SuccessCreated; the body holds the new resource.
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.
Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.