HYPHApar S33D
Documentation › Administrer

API de HYPHA

Tout ce que fait l'interface passe par une API JSON. Une clé d'application suffit pour l'automatiser.

Authentification

UsageCléEn-tête
Lire et écrire comme l'interfaceapplicationX-Hypha-App-Key: hph_…
Envoyer des donnéesingestionX-Hypha-Api-Key: hph_… (OTLP : aussi Authorization: Bearer hph_…)

Les clés se créent dans Réglages › Clés API (voir Comptes et rôles). Une clé d'application agit avec le rôle de son auteur. Adresse de base : https://hypha.s33d.fr/api/v1 (en auto-hébergement, votre adresse).

Conventions

curl -s -H "X-Hypha-App-Key: $HYPHA_APP_KEY" https://hypha.s33d.fr/api/v1/hosts

Lire

RouteRend
GET /hostsles hôtes, leur état et leurs valeurs des 2 dernières minutes (?q=, ?tag=clé:valeur)
GET /hosts/{id}un hôte, son agent, ses derniers contrôles
GET /problemsles groupes hors OK, triés par priorité
GET /monitors, GET /monitors/{id}/historyles moniteurs et l'historique d'un moniteur
POST /metrics/queryséries d'une ou plusieurs requêtes, avec formules
GET /logs/search, /logs/facets, /logs/histogram, /logs/patternsrecherche dans les journaux
GET /apm/services, /apm/traces, /apm/traces/{trace_id}services, traces, détail d'une trace
GET /inventory, /inventory/packages?name=openssl&version_lt=3.5.2inventaire et recherche d'un paquet sur tout le parc
GET /certificatescertificats relevés, triés par échéance
GET /usageconsommation par jour

Exemple de requête de métriques :

curl -s -H "X-Hypha-App-Key: $HYPHA_APP_KEY" -H "Content-Type: application/json" \
  https://hypha.s33d.fr/api/v1/metrics/query \
  -d '{"queries":[{"id":"a","q":"avg:system.cpu.usage{env:prod} by {host}"}],"max_points":300}'

Écrire

RouteEffet
POST /monitors, PUT /monitors/{id}, DELETE /monitors/{id}moniteurs
POST /monitors/from-templatemoniteur depuis un modèle : {"template": "disk_forecast", "vars": {…}}
POST /monitors/{id}/mutesourdine jusqu'à until (ms) ou sans fin (null)
POST /monitors/{id}/groups/ackacquitter un groupe, avec un commentaire
POST /downtimesmaintenance ; {"duration_s": 3600, "scope": {…}} commence tout de suite
POST /incidents, POST /incidents/from-alertincidents
POST /synthetics, POST /synthetics/{id}/runtests synthétiques, exécution immédiate
POST /dashboards, POST /dashboards/importtableaux de bord
POST /actions, POST /actions/{id}/approveproposer et approuver une action à distance
POST /explainexplication par l'IA : {"kind": "alert", "monitor_id": 6, "group": "host:web-02", "lang": "fr"} ; kind vaut aussi host, log, trace ou error

Événements

Un événement apparaît sur la frise, se superpose aux graphiques et peut déclencher un moniteur. Exemple, à la fin d'un déploiement :

curl -s -H "X-Hypha-App-Key: $HYPHA_APP_KEY" -H "Content-Type: application/json" \
  https://hypha.s33d.fr/api/v1/events \
  -d '{"title":"Déploiement boutique-api 2.15.0","source":"deploy","type":"deploy","alert_type":"success",
       "tags":{"service":"boutique-api","version":"2.15.0"}}'

Les graphiques APM et la fiche du service superposent les événements source:deploy.

Envoyer des données

RouteContenu
POST /api/v1/intake/metrics, /logs, /checks, /events, /host…protocole de l'agent (corps JSON, gzip accepté, 10 Mo au plus)
POST /v1/traces, /v1/metrics, /v1/logsOpenTelemetry (OTLP/HTTP, protobuf ou JSON)
POST /api/v1/intake/rum?token=…navigateur (script RUM)

Pour vos propres applications, préférez OpenTelemetry ou StatsD par l'agent : voir Traces et Intégrations. Le serveur accepte des horodatages compris entre 14 jours dans le passé et 10 minutes dans le futur.

Réponses de l'ingestion : 202 {"status":"ok","accepted":N,"dropped":M} ; 401 clé inconnue ; 403 clé révoquée ou de type application ; 413 corps trop gros ; 429 débit ; 402 limite de formule.

Pages publiques

Mise à jour : 19 novembre 2026