Skip to main content
POST
Démarrer l’analyse d’ingestion

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 analyse de code en mode d’ingestion. Au lieu de détecter des problèmes de zéro, une analyse d’ingestion exploite des constats produits ailleurs (par exemple, un rapport SAST) et charge Devin de les trier et de les valider par rapport au dépôt. L’analyse est lancée de manière asynchrone par le répartiteur d’analyses et attribuée au principal appelant.

Champs de la requête

  • repo_name (obligatoire) : nom complet du dépôt, par exemple owner/repo.
  • profile_id (obligatoire) : un profil d’analyse en mode ingest. Un profil en mode discover est rejeté avec le code d’état 400.
  • host : hôte Git du dépôt, s’il ne peut pas être déduit.
  • attachment_urls : URL de fichiers joints Devin (par exemple, un rapport de scanner exporté) à fournir à l’analyse. Importez d’abord les fichiers à l’aide de l’API des fichiers joints.

Erreurs

  • 400 si profile_id ne correspond pas à un profil en mode d’ingestion.
  • 404 si l’organisation, le dépôt ou le profil n’est pas visible par le compte Enterprise.
  • 409 si 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 de l’organisation (préfixe : org-)

Exemple:

"org-abc123def456"

Corps

application/json

Corps de la requête pour démarrer une analyse de code en mode d’ingestion.

Accepte uniquement un profil d’analyse en mode d’ingestion (ingest) : le profil est exécuté sur le dépôt indiqué.

profile_id
string
requis

Profil d’analyse en mode d’ingestion à exécuter. Doit être un profil ingest ; les profils non ingest sont rejetés avec le code 400.

repo_name
string
requis

Nom complet du dépôt à analyser.

attachment_urls
string<uri>[] | null

URL des pièces jointes Devin à fournir à l’analyse, par exemple des fichiers téléversés via l’API des pièces jointes. Les pièces jointes doivent appartenir à l’organisation analysée.

Maximum array length: 10
Required string length: 1 - 2083
host
string | null

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

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