Aller au contenu
FirstSIDocs

Démarrer avec l'API

Ce que couvre l'API publique, comment l'appeler, et la forme de ses réponses.

#/api-tokensadmin (création des jetons)

L'API publique ouvre les données de FirstSI à vos autres outils : outil de tickets, supervision générale, tableaux de bord, scripts, assistants IA. Elle couvre tous les modules. Elle est en lecture, sauf trois écritures précises : acquitter une alerte, régler NetDiag, lancer une action de diagnostic sur un poste.

L'essentiel

L'adresse de base est https://<votre-console>/api/v1. Chaque appel porte un jeton de votre client dans l'en-tête Authorization: Bearer <jeton> (voir Jetons d'API). Un jeton a des portées (read:netdiag, read:flows…) ; une route dont la portée manque répond 403.

Les réponses sont en JSON, de la forme { data, meta }, avec des dates en UTC au format ISO 8601. Chaque jeton a droit à 600 appels par minute ; au-delà, le serveur répond 429 avec un en-tête Retry-After.

Le contrat v1 n'évolue que par ajouts compatibles. Une suppression est annoncée 12 mois à l'avance.

Premier appel

La route /me sert à vérifier un jeton. Elle renvoie son nom, ses portées et sa date d'expiration :

Vérifier un jeton
curl -s https://console.exemple.fr/api/v1/me \
  -H "Authorization: Bearer fsi_live_xxxxxxxxxxxx"

Ensuite, par exemple, la liste des postes équipés de l'agent (portée read:machines) :

Lister les postes
curl -s "https://console.exemple.fr/api/v1/machines?status=online&limit=50" \
  -H "Authorization: Bearer fsi_live_xxxxxxxxxxxx"
Réponse (extrait)
{
  "data": [
    { "id": 21, "hostname": "poste-009", "ip": "10.10.10.9", "os": "Windows 11", "agent_version": "2026.10.7.0",
      "status": "online", "last_seen_at": "2026-10-07T08:12:40Z", "modules": ["netflow", "netdiag"] }
  ],
  "meta": { "limit": 50, "next_cursor": null }
}

Ce que couvre l'API

DomaineExemples de routesPortée
Parc/machines, /machines/{hostname}read:machines
Expérience réseau des postes/netdiag/machines, /netdiag/machines/{hostname}/summaryread:netdiag
Flux réseau/flows, /flows/destinations, /flows/summary, /flows/exploreread:flows
Alertes et disponibilité/alerts, /monitorsread:alerts, read:monitors
Inventaire et vulnérabilités/inventory/…read:inventory
Sécurité (SIEM, Active Directory)/security/…read:security
Bases de données, DNS, fichiers, réseau, pare-feu/databases/…, /dns/…, /files/…, /network/…, /firewall/…la portée read:* correspondante

Toutes les routes et leurs paramètres sont dans la référence de l'API. Votre console sert aussi la spécification OpenAPI (/api/v1/openapi.json) et une documentation interactive (/api/v1/docs).

Pour un assistant IA

Les mêmes données existent sous forme d'outils MCP. Claude, ChatGPT, Copilot ou tout client compatible les appellent eux-mêmes pour répondre à une question du type « quel poste a eu un problème réseau ce matin ? ». Voir Serveur MCP.

Pour aller plus loin

Source : · Docs FirstSI · mis à jour le 10/10/2026