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 le dépôt (repo_name) ou les dépôts (repos) spécifiés 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

Fournissez exactement l’un des champs repo_name ou repos.
  • repo_name : 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.
  • repos : dépôts couverts par une même analyse multi-dépôts, sous forme de liste d’objets comportant repo_name et un host facultatif (jusqu’à 200). La première entrée correspond au dépôt principal de l’analyse.
  • 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.
  • effort : normal (par défaut) réduit l’effort de raisonnement du modèle et traite l’investigation par lots plus volumineux ; deep exécute le pipeline complet.
  • interactive : si true, l’analyse se met en pause à l’état awaiting_user_input entre la modélisation des menaces et l’investigation, afin de permettre une revue par l’utilisateur. Valeur par défaut : false. Seules les analyses de sécurité prennent en charge la revue interactive ; les autres types d’analyse s’exécutent sans intervention.
  • platform : emplacement d’exécution des sessions de l’analyse : soit un libellé de plateforme configuré pour l’organisation (par exemple linux, windows ou macos), soit le nom d’un pool Outposts, sans distinction de casse. Si un nom correspond aux deux, la plateforme est prioritaire. Par défaut, utilise la valeur par défaut de l’organisation.

Erreurs

  • 400 lorsque scan_type est incompatible avec le profil, qu’un scan_type non lié à la sécurité est fourni sans profil, ou que platform ne correspond à aucun libellé de plateforme ni à aucun pool Outposts configuré (le corps de l’erreur indique les valeurs disponibles).
  • 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.
  • 422 lorsque repo_name et repos sont fournis simultanément ou qu’aucun des deux ne l’est, ou lorsque repos est vide.

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.

commit_sha
string | null

Commit à extraire avant l’analyse.

effort
enum<string> | null

Niveau d’effort d’analyse : 'normal' (par défaut) réduit l’effort de raisonnement du modèle et utilise des lots d’investigation plus volumineux ; 'deep' exécute le pipeline complet.

Options disponibles:
normal,
deep
host
string | null

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

interactive
boolean
défaut:false

Lorsque la valeur est true, l’analyse s’interrompt entre la modélisation des menaces et l’investigation pour permettre une revue par l’utilisateur.

platform
string | null

Environnement d’exécution des sessions de l’analyse : un libellé de plateforme configuré pour l’organisation (p. ex. 'linux', 'windows', 'macos') ou le nom d’un pool Outposts (BYOB), sans distinction de casse ; les plateformes sont prioritaires lorsqu’un nom correspond à la fois à une plateforme et à un pool. Si la valeur est omise, la valeur par défaut de l’organisation est utilisée. Les valeurs non reconnues sont rejetées avec une réponse HTTP 400 dont le corps répertorie les libellés de plateforme et les noms de pools Outposts disponibles.

Maximum string length: 128
profile_id
string | null

Profil d’analyse à appliquer à l’analyse.

repo_name
string | null

Nom complet du repository à analyser. Fournissez un seul des deux paramètres repo_name ou repos.

repos
ScanRepoRequest · object[] | null

Repositories couverts par une même analyse ; la première entrée correspond au repository principal de l’analyse. Fournissez un seul des deux paramètres repo_name ou repos.

Maximum array length: 200
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,
cleanup,
telemetry,
accessibility,
compliance,
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).

effort
enum<string>
requis

Niveau d’effort d’analyse : 'normal' réduit l’effort de raisonnement du modèle et utilise des lots d’investigation plus importants ; 'deep' exécute le pipeline complet.

Options disponibles:
normal,
deep
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,
cleanup,
telemetry,
accessibility,
compliance,
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
url
string
requis

URL de la page de l’analyse dans la webapp Devin.

outpost_pool_id
string | null

Pool Outposts sur lequel les sessions de l’analyse s’exécutent, si un pool est défini.

platform
string | null

Libellé de la plateforme hébergée sur laquelle les sessions de l’analyse s’exécutent. Null lorsque l’analyse s’exécute sur un pool Outposts ou utilise la configuration par défaut de l’organisation.

repo_full_name
string | null

Identité du repository principal incluant le nom d’hôte (p. ex. github.com/org/repo). Null pour les dépôts Perforce, qui n’ont pas d’hôte Git.