Zum Inhalt springen

get_scan_status

Zweck

Gibt Zustand, Fortschritt und die vorläufigen Befundzähler eines Laufs zurück. Das Werkzeug ruft GET /v1/scans/{id} auf.

Parameter

NameTypBedeutung
scan_idstringKennung aus start_scan. Pflicht.

Rückgabe

Beispiel
{
"scan_id": "3f9a1c20-5e4b-4d8a-9a11-0c21e7b4c21e",
"domain": "shop.beispiel.de",
"status": "running",
"phase": "Aktive Prüfungen",
"phase_detail": "nuclei-Templates",
"progress": 64,
"counts": { "critical": 1, "high": 2, "medium": 4, "low": 3, "info": 5 },
"finished": false
}

counts ist während des Laufs vorläufig und kann noch steigen. Erst bei status: "done" sind die Zahlen endgültig. finished ist true, sobald der Lauf done, failed oder canceled erreicht hat.

Warten

Rufen Sie das Werkzeug nicht in einer engen Schleife auf. Ein passiver Lauf braucht zwei bis vier Minuten, mit aktiven Prüfungen zehn bis zwanzig. Alle zehn bis dreißig Sekunden nachzusehen reicht. Häufiger läuft in das Rate-Limit von 30 Anfragen je Minute.