Files
SentinelMesh/docs/API.md
T
gilles 7cf56f24ef chore: initialise la structure du projet SentinelMesh
- Workspace Cargo avec backend, agent-scan-network, agent-metric
- Skeleton Rust pour les trois crates (Axum, Tokio, SQLx)
- Documentation : README, FEATURES, ROADMAP, ARCHITECTURE, API, INSTALL
- Exemples de widgets Glance (custom-api)
- Script d'installation agents (squelette Phase 5)
- Docker Compose + Dockerfile backend
- .gitignore et CLAUDE.md

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-19 05:59:12 +02:00

63 lines
2.4 KiB
Markdown

# API SentinelMesh
Base URL : `http://<host>:8080/api/v1/`
Toutes les réponses sont en JSON. Auth par token Bearer (header `Authorization: Bearer <token>`).
## Endpoints
### Santé
| Méthode | Endpoint | Description |
|---------|------------------|--------------------|
| GET | `/api/v1/health` | État du backend |
### Agents
| Méthode | Endpoint | Description |
|---------|-----------------------|--------------------------------|
| GET | `/api/v1/agents` | Liste des agents enregistrés |
| POST | `/api/v1/agents` | Enregistrement d'un agent |
| GET | `/api/v1/agents/{id}` | Détail d'un agent |
### Réseau
| Méthode | Endpoint | Description |
|---------|-----------------------|------------------------------------|
| GET | `/api/v1/network` | Équipements découverts |
| POST | `/api/v1/network` | Push scan depuis agent |
| GET | `/api/v1/network/{ip}`| Détail d'un équipement |
### Métriques
| Méthode | Endpoint | Description |
|---------|-----------------------|------------------------------------|
| GET | `/api/v1/metrics` | Métriques de tous les agents |
| POST | `/api/v1/metrics` | Push métriques depuis agent |
| GET | `/api/v1/metrics/{id}`| Métriques d'un agent |
### Widgets (consommés par Glance)
| Méthode | Endpoint | Cache Glance |
|---------|-------------------------------|--------------|
| GET | `/api/v1/widgets/network` | 30s |
| GET | `/api/v1/widgets/metrics` | 1s |
### Événements
| Méthode | Endpoint | Description |
|---------|-----------------------|--------------------------|
| GET | `/api/v1/events` | Journal des événements |
| POST | `/api/v1/events` | Push événement |
### Installation / Mise à jour
| Méthode | Endpoint | Description |
|---------|-----------------------|--------------------------------|
| GET | `/api/v1/install` | Commande d'installation |
| GET | `/api/v1/update` | Commande de mise à jour |
## Documentation interactive
Swagger UI disponible sur : `http://<host>:8080/swagger-ui/`