REST-API / Artefakte abrufen

Artefakte abrufen

Ein fertiger Lauf hinterlässt den Bericht als report.pdf und, ab dem Plan Pro, die maschinenlesbare Fassung findings.json. Dazu kommen die Evidenz-Dateien der einzelnen Befunde.

Artefakte auflisten

GEThttps://api.red-check.de/v1/scans/{id}/artifacts

Anfrage

curl -X GET https://api.red-check.de/v1/scans/{id}/artifacts \
  -H "Authorization: Bearer rc_live_••••••••"

FeldTypBeschreibung

uuidPflicht

–

kind

enumPflicht

Art eines Artefakts. Über einen Kunden-Zugang erreichbar sind `report_pdf` (jeder Plan) und `findings_json_client` (ab Plan Pro). `findings_json` ist die vollständige Fassung mit Kommandozeilen, Werkzeugspuren und dem ganzen Auftragssatz; sie ist wie `audit_log` und `report_tex` allein der Plattform vorbehalten. Der Kunde bekommt `findings_json_client`, mit genau dem Inhalt, der auch im PDF steht. `branding_logo` hängt an der Organisation und nicht an einem Lauf.report_pdf · findings_json · findings_json_client · audit_log · report_tex · evidence · branding_logo

filename

stringPflicht

–

content_type

string

–

size_bytes

integerPflicht

–

sha256

stringPflicht

–

page_count

integer | null

–

created_at

string (date-time)

–

expires_at

string | null

Nach diesem Zeitpunkt ist das Objekt gelöscht; die Metadaten bleiben.

deleted

boolean

–

Die Liste zeigt nur, was dieser Zugang auch abrufen darf. Im Plan Free steht dort der Bericht und sonst nichts.

Signierte URL

GEThttps://api.red-check.de/v1/scans/{id}/artifacts/{kind}/url

Die Dateien liegen im Objektspeicher und sind nie direkt erreichbar. Dieser Aufruf gibt eine kurzlebige URL zurück, in der Vorgabe 300 Sekunden gültig.

Antwort

{
  "url": "https://api.red-check.de/…",
  "expires_at": "2026-09-03T09:14:22Z",
  "filename": "",
  "watermarked": false
}

PDF herunterladen

URL=$(curl -sS "https://api.red-check.de/v1/scans/$SCAN/artifacts/report_pdf/url" \
-H "Authorization: Bearer $KEY" | jq -r .url)

curl -sS -o bericht.pdf "$URL"

Mögliche Werte für kind: report_pdf, findings_json, report_tex, evidence.

200

Signierte URL.

400

Eingabe ungültig (`validation_failed`).

402

Im aktuellen Plan nicht enthalten (`plan_upgrade_required`).

404

Nicht gefunden (`not_found`).

410

Artefakt nach Ablauf der Aufbewahrung gelöscht (`artifact_expired`).

Aufbewahrung

Wie lange Artefakte bleiben, hängt am Plan. Danach werden PDF, findings.json und Evidenz aus dem Objektspeicher gelöscht; der Abruf antwortet dann mit 410 und dem Code artifact_expired.

Davon getrennt bleibt ein minimaler Scanner-Nachweis bis 365 Tage nach dem endgültigen Scanende erhalten, auch nach der Organisationslöschung. Er enthält keine Befunde, Rohantworten oder privaten Zugangsdaten. Bei aktiver Kennzeichnung bleibt die Auskunft über die zufällige Referenz höchstens 90 Tage nach dem endgültigen Ende erreichbar. Sie enthält nur Organisation, Ziel, Zeitraum und Betreiberkontakt, keine Berichte und keine öffentliche Scanliste.