Passer au contenu principal
GET
Obtenir l’analyse

Autorisations

CORGEA-TOKEN
string
header
requis

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

Paramètres de chemin

scan_id
string<uuid>
requis

L'identifiant de l'analyse

Réponse

Détails de l'analyse récupérés avec succès

id
string<uuid>
project
string
repo
string
branch
string
status
enum<string>

Progression de l’analyse. « scanning » et « processing » sont des états en cours, « complete » signifie que l’analyse est terminée et « incomplete » qu’elle a échoué.

Options disponibles:
scanning,
processing,
complete,
incomplete
engine
string
created_at
string<date-time>
time_taken
number | null

Durée de l’analyse en secondes, ou null tant que le traitement de l’analyse n’est pas terminé

git_sha
string | null

SHA du commit associé à l’analyse

worktree_dirty
boolean | null

Indique si l’analyse incluait des modifications locales non commitées. Vaut null pour les analyses créées sans indication sur l’état du worktree.

metadata
object | null

Métadonnées fournies par l'utilisateur associées à l'analyse

source
enum<string> | null

Indique comment le scan a été démarré ; null si son origine est inconnue.

Options disponibles:
api,
cli,
vscode,
vs2022,
intellij,
github_app,
gitlab,
azure_devops,
bitbucket,
harness,
scheduled,
manual,
demo,
web_upload,
other,
null
triggered_by
object | null

Utilisateur ayant déclenché le scan. Vaut null pour les scans des intégrations de gestion de code source ; il ne s’agit pas de l’auteur de la pull request. L’adresse e-mail peut être utilisée avec le filtre triggered_by.

pull_request_id
string | null

Identifiant de pull request ou de merge request ; null pour les scans sans cette association.