Clés API

Listez vos clés API, créez une clé limitée à certains de vos projets (par exemple une par projet client) et révoquez-en une. Ces endpoints nécessitent une clé de portée read_write valable pour tout le compte.

GET/api_keys

Vos clés API, des plus récentes aux plus anciennes, clés révoquées comprises, avec name, le prefix visible, scope, project_ids (vide pour une clé valable pour tout le compte), last_used_at et revoked_at. Le jeton secret n’est jamais renvoyé. Également disponible en dessous du forfait Scale, pour que vous puissiez toujours révoquer d’anciennes clés.

Paramètres :
  • page
  • per_page20 par défaut, 100 maximum

POST/api_keys

Crée une clé limitée aux projets indiqués dans project_ids et rattachée à l’utilisateur de la clé appelante. Son token secret n’est renvoyé que dans cette réponse : conservez-le. La clé ne voit jamais les autres projets, et cet endpoint ne crée jamais de clé valable pour tout le compte. Un projet auquel vous n’avez pas accès renvoie ERR_PROJECT_NOT_FOUND et, dès que vous avez 500 clés actives, l’endpoint renvoie ERR_LIMIT_REACHED jusqu’à ce que vous en révoquiez une. Nécessite le forfait Scale ou supérieur.

Corps (JSON) :
  • nameobligatoire, 100 caractères maximum
  • project_idsobligatoire, au moins un ID de projet
  • scoperead par défaut, ou read_write

DELETE/api_keys/:id

Révoque l’une de vos clés : elle cesse aussitôt de fonctionner et ne peut pas être restaurée. La révoquer de nouveau ne change rien. Également disponible en dessous du forfait Scale.

Chemin :
  • :idID de la clé, fourni par GET /api_keys

Renvoie ERR_NOT_FOUND pour la clé d’un autre utilisateur.