FAQ — API publique
L'API est-elle prête pour la production ?
Elle est en préversion (v1alpha1) : les chemins, les champs et l'URL publique peuvent encore évoluer. Vous pouvez l'utiliser pour vos automatisations, à condition de suivre ses évolutions dans le changelog.
Comment obtenir une clé d'API ?
Un administrateur du projet ou de l'organisation la crée dans la console, carte Clés d'API des paramètres du projet, en choisissant son nom, son niveau de droits et sa durée de validité (voir Obtenir une clé).
Où trouver l'identifiant de mon projet ?
Dans l'exemple d'appel que la console affiche à la création d'une clé d'API : c'est l'UUID qui suit /projects/. Il est distinct du nom du projet et de l'ID de l'Organisation affiché dans Mon Compte.
Puis-je utiliser une même clé pour plusieurs projets ?
Non. Une clé est rattachée à un seul projet et toute requête visant un autre projet est refusée. Utilisez une clé par projet.
Puis-je créer une clé d'API avec une autre clé d'API ?
Non. La gestion des clés est réservée aux administrateurs, depuis leur session dans la console : une clé ne peut ni créer ni révoquer de clé. Cela empêche une clé compromise de se recréer des accès.
Quel scope choisir ?
read pour consulter (inventaire, supervision), admin pour créer, modifier ou supprimer des ressources (déploiement). Voir Scopes.
Pourquoi une clé ne peut-elle pas être illimitée ?
Une clé oubliée ou divulguée finit ainsi par expirer d'elle-même. La durée maximale est d'un an (365d) ; prévoyez le remplacement des clés de vos intégrations avant leur expiration.
J'ai perdu le secret de ma clé. Peut-on me le renvoyer ?
Non. Hikube ne conserve qu'une empreinte du secret, qui n'est affiché qu'à la création. Révoquez la clé perdue et créez-en une nouvelle, ou utilisez Renouveler dans la carte Clés d'API : la console crée une clé de même nom et de même niveau, puis propose de révoquer l'ancienne.
Ma clé a fuité. Que faire ?
Révoquez-la immédiatement dans la carte Clés d'API des paramètres du projet. Si vous passez par le support, donnez son keyId, jamais le secret. La révocation prend effet dès la requête suivante. Créez ensuite une nouvelle clé et cherchez où l'ancienne a pu être utilisée.
Toutes mes requêtes renvoient 403 avec le code 10002. Pourquoi ?
Cette réponse unique couvre tous les refus : clé invalide, expirée ou révoquée, mauvais identifiant de projet, scope insuffisant, ou opération non accessible aux clés. Voir Accès refusé.
Toutes les opérations de la console sont-elles disponibles dans l'API ?
Non. L'API couvre les ressources des projets (VM, disques, buckets, Kubernetes, réseau, bases de données, RabbitMQ) et les catalogues. La gestion du compte, de l'organisation, des projets, des membres et des clés reste dans la console. La référence de l'API liste exactement les opérations disponibles.
Existe-t-il un client officiel ou un provider Terraform ?
Pas encore. Vous pouvez générer un client dans votre langage depuis la spécification OpenAPI. Un provider Terraform fondé sur l'API publique est envisagé (voir Terraform).
L'API impose-t-elle un nombre maximal de requêtes ?
La préversion ne documente pas de limite de débit. Évitez néanmoins d'interroger l'état d'une ressource en boucle serrée : un intervalle de quelques secondes entre deux GET suffit pour suivre une création.