Zum Hauptinhalt springen
PATCH
Scan-Upload fortsetzen

Autorisierungen

CORGEA-TOKEN
string
header
erforderlich

API-Key für die Authentifizierung API-Tokens inaktiver Benutzer werden abgelehnt.

Header

Upload-Offset
integer
erforderlich

Aktueller Byte-Offset des Uploads

Upload-Length
integer
erforderlich

Gesamtgröße der Datei in Byte

Upload-Name
string
erforderlich

Name der hochgeladenen Datei

CORGEA-SOURCE
enum<string>
Standard:api

Identifiziert den Client, der den Scan ausgelöst hat. Anfragen ohne diesen Header werden der API zugeordnet.

Verfügbare Optionen:
api,
cli,
vscode,
vs2022,
intellij
CORGEA-CLI-VERSION
string

Optionale CLI-Version, die mit dem Scan gespeichert wird. Verwenden Sie 1–64 Buchstaben, Ziffern, Punkte, Pluszeichen oder Bindestriche; ungültige Werte werden ignoriert.

Maximum string length: 64
Pattern: ^[0-9A-Za-z.+-]{1,64}$

Pfadparameter

transfer_id
string<uuid>
erforderlich

Transfer-ID aus dem initialen Scan-Request

Body

multipart/form-data
chunk_data
file
erforderlich

Nächster Daten-Chunk für den Scan

project_name
string
branch
string
repo_url
string
sha
string
partial_scan
enum<string>
Standard:false

Senden Sie true für einen partiellen Scan oder false für einen vollständigen Scan. Ohne Angabe wird ein vollständiger Scan ausgeführt.

Verfügbare Optionen:
true,
false
files_to_scan
string

Repository-relative Pfade als Zeichenkette mit einem JSON-Array, zum Beispiel ["src/app.py","src/a,b.py"]. Ältere kommagetrennte Listen werden ebenfalls akzeptiert. Die Pfade müssen im hochgeladenen ZIP vorhanden sein, gegebenenfalls innerhalb seines übergeordneten Ordners. Eine leere Liste ist zulässig.

metadata
string

Vom Benutzer bereitgestellte Scan-Metadaten als JSON-Objekt-String, z. B. {"pipeline_url":"https://ci.example/run/123"}. Sie werden bei jedem Chunk-Request validiert und nach Abschluss des Uploads dem Scan zugeordnet. Der Wert muss ein JSON-Objekt mit höchstens 16.384 Byte sein; andernfalls schlägt der Request mit Status 400 fehl.

dirty
enum<string>

Ob der hochgeladene Worktree dirty ist. Die CLI sendet true oder false, wenn Repo-Infos vorliegen. Lassen Sie das Feld weg, wenn der Status unbekannt ist.

Verfügbare Optionen:
true,
false
scan_configs
string

Kommagetrennte Scan-Typ-Tokens, die nach Abschluss des Uploads gelten (base, malicious, policy, secrets, pii und weitere). Die CLI mappt --scan-type blast auf base. Weglassen für Server-Standardwerte.

target_policies
string

Kommagetrennte Policy-IDs, die nach Abschluss des Uploads gelten. Ungültige IDs liefern 400.

incremental_ignore_rules
string

Zeichenkette mit einem JSON-Objekt und den Arrays base und current für Ignoriermuster. Wenn eine Ignorierregel der Baseline aufgehoben wird, müssen alle neu erfassten Dateien in incremental_changed_files stehen. Wird eine Baseline-Regel ohne übereinstimmende Regelsätze aufgehoben, führt Corgea einen vollständigen Scan aus.

incremental_skipped_reason
string

Optionaler Diagnosegrund für einen Upload ohne inkrementellen Diff. Verwenden Sie 1–64 Kleinbuchstaben, Ziffern oder Unterstriche. Ungültige Werte werden ignoriert; die serverseitige inkrementelle Analyse bleibt möglich.

incremental_skipped_detail
string

Optionale Diagnosedetails für incremental_skipped_reason, auf 2.000 Zeichen begrenzt.

Antwort

Chunk akzeptiert. Zwischenresponses setzen Upload-Offset. Abschlussantworten und Antworten bei bereits laufendem Scan tun das nicht.

status
enum<string>
erforderlich
Verfügbare Optionen:
ok
Beispiel:

"ok"

message
string
erforderlich
scan_id
string<uuid>

Enthalten, wenn der letzte Chunk das Archiv vervollständigt und ein Scan startet.

Beispiel:

"1a5afaa3-72ac-458f-a492-ac40ffc88e76"

project_id
integer

Zusammen mit scan_id enthalten, wenn ein Scan startet.