REST-API / Scans auflisten

Scans auflisten

Liefert die Läufe der Organisation, neueste zuerst. Ein Schlüssel mit Domain-Einschränkung sieht nur die Läufe seiner Domains.

Anfrage

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

Anfrage

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

Filter

ParameterTypBeschreibung

domain_id

uuid

–

schedule_id

uuid

Nur Läufe, die aus diesem Zeitplan entstanden sind. Ohne diesen Filter lässt sich die Frage „alle Läufe dieses Zeitplans“ nicht beantworten, obwohl die Zuordnung am Lauf gespeichert ist.

status

enum[]

–queued · leased · running · done · failed · canceled · awaiting_review

tier

enum

–passive · active · hacking

module

enum

Nur Läufe, die diesen Prüfbereich enthalten. Ein Lauf kann mehrere Prüfbereiche tragen; gefiltert wird darauf, ob der Bereich enthalten ist, nicht darauf, ob er der einzige ist.security · privacy · accessibility · ki

from

string (date-time)

–

string (date-time)

–

string

Suche über Domain oder Scan-Kennung.

limit

integer

–

cursor

string

Undurchsichtiger Zeiger aus `next_cursor` der vorigen Seite.

Mehrere Zustände werden mit Komma getrennt, ohne Leerzeichen:

Nur laufende und wartende Läufe

GET /v1/scans?status=queued,running&limit=50

Antwort

Ein Eintrag aus items

{
  "id": "3f9a1c20-5e4b-4d8a-9a11-0c21e7b4c21e",
  "domain": "",
  "tier": "passive",
  "status": "queued",
  "progress": 0,
  "counts": {
    "critical": 0,
    "high": 0,
    "medium": 0,
    "low": 0,
    "info": 0
  },
  "created_at": "2026-09-03T09:14:22Z"
}

Blättern

Die Liste ist seitenweise. limit nimmt Werte von 1 bis 200, Vorgabe 50. Solange next_cursor nicht null ist, gibt es eine weitere Seite. Die Regeln für alle Listen stehen unter Konventionen.

Alle Seiten holen

cursor=""
while :; do
page=$(curl -sS "https://api.red-check.de/v1/scans?limit=100&cursor=$cursor" \
  -H "Authorization: Bearer $KEY")
echo "$page" | jq -c '.items[]'
cursor=$(echo "$page" | jq -r '.next_cursor // empty')
[ -z "$cursor" ] && break
done

Jede Seite ist eine Anfrage und zählt gegen das Rate-Limit von 30 Anfragen je Minute und Schlüssel.

200

Läufe.

400

Eingabe ungültig (`validation_failed`).

401

Nicht angemeldet (`unauthenticated`) oder zweiter Faktor nicht erbracht (`totp_required`).