Aller au contenu principal

API

Tout ce que vous pouvez faire dans l'interface de Red Kite, et plus encore, est accessible au moyen de l'API. Utilisez-la pour automatiser vos flux de travail, alimenter Red Kite avec des données provenant d'autres systèmes ou envoyer les résultats de Red Kite vers les outils que vos équipes utilisent déjà.

Authentification​

L'API utilise des clés d'API. Créez-en une dans votre profil, puis passez-la dans l'en-tête x-api-key de chaque requête. Consultez Clés d'API.

export RK_API_KEY="my key value"
curl -H "x-api-key: $RK_API_KEY" https://<your-red-kite-url>/api/

L'API est accessible sous /api/ à l'adresse de votre instance Red Kite. Une requête GET /api/ping non authentifiée répond par une simple chaîne de caractères, ce qui est pratique pour vérifier la connectivité.

Documentation de référence​

La documentation OpenAPI de votre instance liste chaque point de terminaison, avec ses paramètres et ses réponses :

  • Swagger UI : https://<your-red-kite-url>/api/docs/
  • OpenAPI JSON : https://<your-red-kite-url>/api/docs-json

Filtrage​

Les points de terminaison qui listent les ressources et les intels acceptent le même langage de requête que l'interface. Par exemple, confidence:verified port:22 retourne les ports SSH vérifiés. Consultez Rechercher pour la syntaxe complète.

Intégrer des systèmes tiers​

Red Kite peut être connecté à vos autres outils de trois façons.

Comme source de données​

Alimentez Red Kite avec des données provenant d'autres systèmes, comme une CMDB, un fournisseur DNS, un fournisseur infonuagique ou un outil de gestion des adresses IP :

  • avec une tâche (job) qui interroge le système et émet des findings pour les domaines, les hôtes et les plages IP qu'il connaît, déclenchée par un abonnement cron;
  • ou avec un script qui envoie les données à l'API.

Comme sortie​

Envoyez les résultats de Red Kite vers les systèmes que vos équipes utilisent déjà. Par exemple :

  • ouvrir des billets Jira pour les nouvelles intels ou les nouvelles ressources vérifiées;
  • envoyer les nouvelles ressources de la semaine dans un canal de clavardage;
  • exporter les ressources en JSON ou en CSV pour la production de rapports.

Un script qui utilise l'API peut interroger les ressources et les intels avec les mêmes filtres que l'interface, par exemple is:open severity:critical pour les intels.

Pour l'orchestration​

Utilisez Red Kite comme source de vérité pour piloter d'autres outils. Par exemple, lancez des analyses Nessus sur les actifs que vous avez vérifiés : une tâche qui appelle l'API de Nessus avec un secret, exécutée par un abonnement, ou un script externe qui obtient de l'API les hôtes correspondant à confidence:verified et démarre les analyses.

astuce

Créez un utilisateur dédié pour chaque intégration, avec seulement les permissions dont il a besoin, et donnez une date d'expiration à sa clé d'API. Consultez Gérer les rôles et les permissions.