Skip to main content
PATCH
Scan-Upload fortsetzen

Autorisierungen

CORGEA-TOKEN
string
header
erforderlich

API-Key für die Authentifizierung

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

Identifies the client that triggered the scan. Requests without this header are attributed to the API.

Verfügbare Optionen:
api,
cli,
vscode,
vs2022,
intellij

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>

Lassen Sie dieses Feld bei einem vollständigen Scan weg. Senden Sie true nur bei einem partiellen Scan. Die API behandelt jeden nicht leeren Formularwert als partiellen Scan, einschließlich der Zeichenkette false.

Verfügbare Optionen:
true
files_to_scan
string

Kommagetrennte Liste der zu scannenden Dateien

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.

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.