Skip to main content
POST
Lancer l’analyse de code

Autorisations

Requiert un utilisateur de service ou un jeton d’accès personnel disposant de l’autorisation UseAccountCodeScans au niveau de l’entreprise.

Comportement

Met en file d’attente une nouvelle analyse de code pour repo_name dans l’organisation indiquée. L’analyse est lancée de manière asynchrone par le répartiteur d’analyses ; la réponse contient l’enregistrement de l’analyse avec un status initial défini sur waiting ou pending. Interrogez périodiquement List Code Scans pour suivre sa progression et List Code Scan Findings (filtré par scan_id) pour consulter les résultats une fois l’analyse au statut completed. L’analyse est attribuée au principal appelant (l’utilisateur de service ou le PAT ayant effectué la requête).

Champs de la requête

  • repo_name (obligatoire) : nom complet du dépôt, par ex. owner/repo. Le dépôt doit déjà être accessible via l’intégration Git de l’organisation.
  • host : hôte Git du dépôt, s’il ne peut pas être déterminé automatiquement.
  • profile_id : profil d’analyse à appliquer. Utilisez Start Ingestion Scan pour les profils en mode ingest.
  • scan_type : type d’analyse à exécuter. Doit correspondre au type d’analyse du profil lorsque profile_id est fourni. Par défaut, utilise le type du profil ou security pour les analyses sans profil. Les types d’analyse autres que security nécessitent un profil.
  • commit_sha : commit à extraire avant l’analyse. Par défaut, utilise le dernier commit de la branche par défaut du dépôt.

Erreurs

  • 400 lorsque scan_type est incompatible avec le profil ou qu’un scan_type non lié à la sécurité est fourni sans profil.
  • 403 lorsque l’organisation est limitée aux analyses par ingestion et qu’aucun profil en mode ingest n’est fourni.
  • 404 lorsque l’organisation, le dépôt ou le profil n’est pas visible par le compte Enterprise.
  • 409 lorsque le backlog d’analyses de l’organisation est saturé. Réessayez plus tard.

Autorisations

Authorization
string
header
requis

Identifiant de compte de service (préfixe : cog_)

Paramètres de chemin

org_id
string
requis

ID d’organisation (préfixe : org-)

Exemple:

"org-abc123def456"

Corps

application/json

Corps de la requête pour lancer une nouvelle analyse de code.

repo_name
string
requis

Nom complet du dépôt à analyser.

commit_sha
string | null

Commit à extraire avant l’analyse.

host
string | null

Hôte Git du dépôt, s’il est connu.

profile_id
string | null

Profil d’analyse à appliquer à l’analyse.

scan_type
enum<string> | null

Type d'analyse à exécuter. Doit correspondre au type d'analyse du profil lorsqu'un profil est fourni ; utilise par défaut le type du profil, ou 'security' pour les analyses sans profil. Les types autres que security nécessitent un profil et sont refusés sans celui-ci.

Options disponibles:
security,
performance,
db-queries,
test-coverage,
dead-code,
code-quality,
telemetry,
accessibility,
general,
migration-docs

Réponse

Réponse réussie

Une analyse de code.

created_at
integer
requis

Date de création de l’analyse (secondes Unix).

host
string | null
requis

Hôte Git du dépôt, s’il est connu.

org_id
string
requis

Organisation à laquelle l’analyse appartient.

profile
CodeScanProfileResponse · object | null
requis

Profil avec lequel l’analyse a été exécutée, le cas échéant.

repo_name
string
requis

Dépôt principal de l’analyse. Les analyses multi-dépôts couvrent des dépôts supplémentaires non répertoriés ici.

scan_id
string
requis

Identifiant unique de l’analyse.

scan_type
enum<string>
requis

Type d'analyse, défini lors de la création.

Options disponibles:
security,
performance,
db-queries,
test-coverage,
dead-code,
code-quality,
telemetry,
accessibility,
general,
migration-docs
status
enum<string>
requis

Statut de l’analyse : waiting, pending, running, awaiting_user_input, completed, failed ou cancelled.

Options disponibles:
waiting,
pending,
running,
awaiting_user_input,
completed,
failed,
cancelled