Passer au contenu principal
PATCH
Poursuivre le téléversement de l’analyse

Autorisations

CORGEA-TOKEN
string
header
requis

Clé API pour l'authentification Les jetons API des utilisateurs inactifs sont refusés.

En-têtes

Upload-Offset
integer
requis

Décalage actuel du téléversement, en octets

Upload-Length
integer
requis

Taille totale du fichier en octets

Upload-Name
string
requis

Nom du fichier en cours de téléversement

CORGEA-SOURCE
enum<string>
défaut:api

Identifie le client qui a déclenché l’analyse. Les requêtes sans cet en-tête sont attribuées à l’API.

Options disponibles:
api,
cli,
vscode,
vs2022,
intellij
CORGEA-CLI-VERSION
string

Version facultative de la CLI enregistrée avec le scan. Utilisez 1 à 64 lettres, chiffres, points, signes plus ou traits d’union ; les valeurs non valides sont ignorées.

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

Paramètres de chemin

transfer_id
string<uuid>
requis

ID de transfert de la requête d’analyse initiale

Corps

multipart/form-data
chunk_data
file
requis

Le prochain bloc de données pour l'analyse

project_name
string
branch
string
repo_url
string
sha
string
partial_scan
enum<string>
défaut:false

Envoyez true pour un scan partiel ou false pour un scan complet. Sans valeur, un scan complet est effectué.

Options disponibles:
true,
false
files_to_scan
string

Chemins relatifs au dépôt encodés dans une chaîne contenant un tableau JSON, par exemple ["src/app.py","src/a,b.py"]. Les anciennes listes séparées par des virgules sont également acceptées. Les chemins doivent exister dans le ZIP envoyé, éventuellement dans son dossier englobant. Une liste vide est autorisée.

metadata
string

Métadonnées d’analyse fournies par l’utilisateur sous la forme d’une chaîne représentant un objet JSON, par exemple {"pipeline_url":"https://ci.example/run/123"}. Elles sont validées à chaque requête de fragment et associées à l’analyse une fois le téléversement terminé. L’objet JSON ne doit pas dépasser 16 384 octets, faute de quoi la requête échoue avec le code 400.

dirty
enum<string>

Indique si l’arbre de travail envoyé est dirty. Le CLI envoie true ou false lorsqu’il a des infos de dépôt. Omettez le champ si l’état est inconnu.

Options disponibles:
true,
false
scan_configs
string

Jetons de type de scan séparés par des virgules, appliqués une fois le chargement terminé (base, malicious, policy, secrets, pii, et d’autres). Le CLI convertit --scan-type blast en base. Omettez pour les valeurs par défaut du serveur.

target_policies
string

IDs de politiques séparés par des virgules, appliqués une fois le chargement terminé. Des IDs invalides renvoient 400.

incremental_ignore_rules
string

Chaîne contenant un objet JSON avec les tableaux base et current de motifs d’exclusion. Si une règle d’exclusion de la référence est levée, incluez tous les fichiers désormais exposés dans incremental_changed_files. Si une règle de la référence est levée sans ensembles de règles concordants, Corgea effectue un scan complet.

incremental_skipped_reason
string

Motif de diagnostic facultatif pour un envoi sans diff incrémental. Utilisez 1 à 64 lettres minuscules, chiffres ou traits de soulignement. Les valeurs non valides sont ignorées ; cela ne désactive pas le scan incrémental côté serveur.

incremental_skipped_detail
string

Détail de diagnostic facultatif pour incremental_skipped_reason, limité à 2 000 caractères.

Réponse

Bloc accepté. Les réponses intermédiaires définissent Upload-Offset. Les réponses de fin et « déjà en cours » ne le font pas.

status
enum<string>
requis
Options disponibles:
ok
Exemple:

"ok"

message
string
requis
scan_id
string<uuid>

Présent lorsque le dernier bloc complète l’archive et qu’un scan démarre.

Exemple:

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

project_id
integer

Présent avec scan_id lorsqu’un scan démarre.