-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi_docs.txt
More file actions
33 lines (25 loc) · 1.14 KB
/
api_docs.txt
File metadata and controls
33 lines (25 loc) · 1.14 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# REST API - AI Red Team Bot
Questa API REST consente di orchestrare e integrare il bot con altri strumenti, dashboard, pipeline CI/CD, ecc.
## Avvio
- Avvia il bot in modalità API con il flag `--api`.
- La REST API gira su `http://127.0.0.1:8000` di default.
- Documentazione interattiva Swagger su `/docs`.
## Endpoints principali
- `POST /scan` — Avvia una scansione su uno o più target.
- Body: `{ "targets": ["host1", "host2"], "options": { ... } }`
- Risposta: ID scansione e stato.
- `GET /status` — Stato delle scansioni in corso e storico.
- `GET /results/{scan_id}` — Risultati dettagliati di una scansione.
- `GET /plugins` — Elenco plugin caricati.
- `GET /health` — Healthcheck API.
## Sicurezza
- Di default solo localhost.
- Possibilità di API key (vedi README).
## Esempio chiamata scan
```bash
curl -X POST http://127.0.0.1:8000/scan -H "Content-Type: application/json" -d '{"targets": ["192.168.1.1"]}'
```
## Note
- Tutte le funzionalità CLI sono disponibili anche via API.
- La documentazione OpenAPI è sempre aggiornata su `/docs`.
- Per personalizzazioni avanzate, vedi README.txt.