Skip to main content
PATCH
Poursuivre le téléversement de l’analyse

Autorisations

CORGEA-TOKEN
string
header
requis

Clé API pour l'authentification

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

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

Options disponibles:
api,
cli,
vscode,
vs2022,
intellij

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>

Omettez ce champ pour un scan complet. Envoyez true uniquement pour un scan partiel. L’API traite toute valeur de formulaire non vide comme un scan partiel, y compris la chaîne false.

Options disponibles:
true
files_to_scan
string

Liste de fichiers à analyser séparés par des virgules

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.

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.