start_scan
Zweck
Reiht einen Lauf gegen eine Domain der Organisation ein. Das Werkzeug ruft
POST /v1/scans auf, und es gelten dieselben
Prüfungen: Kontingent, Preis, 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. |
security | boolean | Sicherheitsprüfung. Vorgabe true. |
privacy | boolean | Datenschutzprüfung im echten Browser. Ohne Angabe gilt die Vorgabe des Plans, im Plan Agentur aus. |
accessibility | boolean | Barrierefreiheit nach WCAG 2.2 AA, BITV 2.0 und BFSG. Vorgabe false. |
full_site | boolean | Alle gefundenen Unterseiten statt einer Stichprobe. Vorgabe false. |
path_prefix | string | Teilscan unter diesem Pfad, etwa /shop. Nur mit der Sicherheitsprüfung allein. |
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, weil ein Modell den Namen kennt
und nicht die UUID. Redcheck löst ihn intern auf domain_id auf.
Rückgabe
Beispiel
{
"scan_id": "3f9a1c20-5e4b-4d8a-9a11-0c21e7b4c21e",
"domain": "shop.beispiel.de",
"tier": "active",
"status": "queued",
"expected_duration_minutes": 14
}Fehler
Fehler kommen als Werkzeugergebnis mit isError: true, der Code steht in
error.code. Die HTTP-Antwort auf /mcp hat den Status 200, siehe
Einrichtung.
| Code | Bedeutung |
|---|---|
domain_not_verified | active: true ohne verifizierte Domain |
not_found | Die Domain gehört nicht zur Organisation oder liegt außerhalb der Domain-Einschränkung |
quota_exceeded | Das Kontingent ist aufgebraucht |
price_not_set | Für ein Paket des Laufs ist kein Preis vereinbart |
payment_method_required | Keine Zahlungsart oder Rechnungsanschrift hinterlegt |
plan_upgrade_required | Der Plan enthält MCP nicht, oder ein Prüfbereich fehlt im Plan |
api_key_scope_insufficient | Der Schlüssel hat das Recht read_only |
hacking_not_available | Ein Feld tier, hacking oder stufe wurde übergeben |
organization_throttled | Die Organisation ist gedrosselt |
rate_limited | Mehr als 30 Anfragen je Minute mit diesem Schlüssel oder mehr als 300 je Minute in der Organisation; die Meldung nennt die Grenze, die griff |