La référence de l'API est publiée en anglais.

Create a named personal API key

POST/api/board-api-keys
Personal API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

Create a named personal API key.

Autorisation

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. Fonctionnement des clés.

Corps de la requête

application/json · obligatoire

namestringFacultatif1–120 characters
expiresAtstring (date-time) | nullFacultatif
requestedCompanyIdstring (uuid) | nullFacultatif

Réponses

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.

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Members, invites and keys