Einstieg / Übersicht

Übersicht

Mit der Redcheck-API starten Sie Scans, verfolgen ihren Fortschritt und holen die Berichte ab. Die Web-App benutzt dieselbe Schnittstelle, eine zweite mit mehr Rechten gibt es nicht.

Die Feldtabellen und Beispiele dieser Referenz entstehen aus dem Vertrag contracts/openapi.yaml, derzeit in der Fassung 1.13.0.

Basis-URL und Version

GEThttps://api.red-check.de/v1/health

Die Version steht im Pfad. Innerhalb von v1 kommen Felder hinzu, es fallen aber keine weg. Ihr Client sollte unbekannte Felder deshalb ignorieren.

Plan	REST mit API-Schlüssel	MCP-Server
Free	nein	nein
Pro	ja	nein
Agentur	ja	ja

Die API prüft den Plan bei jedem Aufruf. Einzelheiten stehen unter Konventionen.

Der kürzeste Weg

In der Web-App unter Einstellungen → API-Keys einen Schlüssel anlegen. Das dürfen Inhaber und Admins. Der Schlüssel wird genau einmal angezeigt.
Domain anlegen, siehe Domains. Für aktive Prüfungen zusätzlich verifizieren, für rein passive Läufe genügt das Anlegen.
Scan starten und die zurückgegebene id merken.
Scan-Status abfragen, bis status auf done steht.
Artefakte abrufen: das PDF und findings.json.

Fehler

Jede Fehlerantwort hat denselben Körper mit den Feldern code, message, details und request_id. Werten Sie code aus, der Text in message ist für Menschen und kann sich ändern. Alle 30 Codes mit ihrem HTTP-Status stehen unter Konventionen.

Grenzen

Jede Anfrage wirkt in genau einer Organisation, bei einem API-Schlüssel in der Organisation des Schlüssels. Kein Parameter übersteuert das.

Ein Schlüssel darf höchstens 30 Anfragen je Minute stellen, alle Schlüssel einer Organisation zusammen 300. Darüber antwortet die API mit 429 rate_limited und dem Kopf Retry-After, siehe Rate-Limits.