API-Dokumentation

Checkvanta hat eine offene REST-API. Scans starten, Ergebnisse abrufen, Verläufe lesen — für die Grundfunktionen dauerhaft kostenlos.

Authentifizierung

Die öffentlichen Endpunkte (Scan starten, Ergebnis, Verlauf, Badge) sind ohne Schlüssel nutzbar und rate-limitiert. Für höhere Limits erstelle einen API-Key im Konto und sende ihn als Bearer-Token.

Authorization: Bearer <API-KEY>

Endpunkte

POST/api/v1/scans

Startet einen Scan und liefert eine jobId. Optional: modules[], dkimSelector.

curl -X POST https://checkvanta.com/api/v1/scans \
  -H "Content-Type: application/json" \
  -d '{"hostname":"example.com"}'
# → { "jobId": "…" }

GET/api/v1/scans/:id

Aktueller Status + Ergebnisse eines Scans.

curl https://checkvanta.com/api/v1/scans/<jobId>

GET/api/v1/scans/:id/stream

Server-Sent-Events: Live-Fortschritt pro Modul.

curl -N https://checkvanta.com/api/v1/scans/<jobId>/stream

GET/api/v1/reports/:id?format=json|csv|pdf&lang=de|en

Vollständiger Bericht als JSON, CSV oder PDF.

curl "https://checkvanta.com/api/v1/reports/<jobId>?format=json"

GET/api/v1/history?host=example.com

Score-Verlauf einer Domain über alle Scans.

curl "https://checkvanta.com/api/v1/history?host=example.com"

GET/api/v1/badge/:domain.svg

Live-Score-Badge (SVG) zum Einbetten.

<img src="https://checkvanta.com/api/v1/badge/example.com.svg" alt="Checkvanta score">

Rate-Limits

Anonyme Anfragen sind pro IP begrenzt, API-Keys pro Organisation. Antworten enthalten X-RateLimit-*-Header.

Maschinenlesbare Spezifikation

Die vollständige OpenAPI-Spezifikation: /api/v1/openapi.json