Faire tourner une clé
Remplacer une clé API par une nouvelle sans interruption de service, à l'échéance ou pour changer ses droits, puis révoquer l'ancienne.
- Duration
- 15 min
This page has not been translated yet and is shown in French.
Une clé ne se modifie pas : pour changer ses droits, ses adresses autorisées ou repousser son expiration, on la remplace. La rotation consiste à faire coexister l'ancienne et la nouvelle clé le temps de déployer la nouvelle, puis à révoquer l'ancienne.
Avant de commencer
- Notez le nom et les 10 premiers caractères de la clé actuelle, par exemple
sk_test_ex. - Prévoyez la rotation avant la date d'expiration : une clé expirée est refusée immédiatement.
Obtenir la nouvelle clé
- Demandez une nouvelle clé au support Wakastart, avec les mêmes informations que la clé actuelle (voir Obtenir une clé API), en indiquant les éventuels changements.
- Précisez qu'il s'agit d'une rotation et que l'ancienne clé doit rester active jusqu'à votre confirmation.
Résultat : vous recevez une nouvelle clé ; les deux clés fonctionnent en parallèle.
Déployer la nouvelle clé
-
Remplacez la valeur du secret qui contient la clé par la nouvelle clé (voir Stocker une clé en sécurité).
-
Redéployez ou redémarrez les services qui l'utilisent.
-
Vérifiez qu'un appel à l'API répond
200avec la nouvelle clé :Bashcurl -s -o /dev/null -w "%{http_code}\n" \ "https://api.wakastart.app/api/config/users?limit=1" \ -H "x-api-key: $WAKASTART_API_KEY"Réponse attendue :
Texte200
Révoquer l'ancienne clé
- Attendez que plus aucune instance n'utilise l'ancienne clé (fin des tâches en cours, redémarrage de tous les réplicas).
- Demandez la révocation de l'ancienne clé au support, en citant son nom et son préfixe (voir Révoquer une clé).
Résultat : seule la nouvelle clé fonctionne.
Vérifier le résultat
Un appel avec l'ancienne clé répond 401 « Cle API utilisateur invalide ou expiree » ; un appel avec la nouvelle répond 200.