start_scan
Zweck
Reiht einen Lauf gegen eine Domain der Organisation ein. Hülle um
POST /v1/scans; es gelten dieselben Prüfungen —
Kontingent, Verifikation, Drossel.
Parameter
| Name | Typ | Bedeutung |
|---|---|---|
domain | string | Domainname. Muss der Organisation gehören. Pflicht. |
active | boolean | Aktive Prüfungen. Setzt eine verifizierte Domain voraus. Vorgabe false. |
privacy | boolean | Datenschutz-Prüfung im echten Browser. Vorgabe true. |
context | enum | shop · brochure · saas · internal. Ohne Angabe gilt der Kontext der Domain. |
cve_include_possible | boolean | Auch „mögliche“ CVE aufnehmen. Vorgabe false. |
Das Werkzeug nimmt den Domainnamen entgegen, nicht die Kennung — ein Modell
kennt den Namen, nicht die UUID. Intern wird auf domain_id aufgelöst.
Rückgabe
Beispiel
{
"scan_id": "3f9a1c20-5e4b-4d8a-9a11-0c21e7b4c21e",
"domain": "shop.beispiel.de",
"tier": "active",
"status": "queued",
"expected_duration_minutes": 14
}Fehler
| Code | Bedeutung |
|---|---|
domain_not_verified | active: true ohne verifizierte Domain |
not_found | Die Domain gehört nicht zu dieser Organisation |
quota_exceeded | Das Kontingent des Plans ist aufgebraucht |
api_key_scope_insufficient | Der Schlüssel darf keine Scans starten |
organization_throttled | Die Organisation ist gedrosselt |