Code-Scan starten (Devin API)
Starten Sie über die v3-Organisations-API einen neuen Devin-Code-Scan für ein Repository, optional mit einem Scan-Profil oder Commit-SHA
Berechtigungen
UseCodeScans auf Organisationsebene.
Verhalten
repo_name in der Organisation in die Warteschlange. Der Scan wird vom Scan-Dispatcher asynchron gestartet; die Antwort enthält den Scan-Datensatz mit dem anfänglichen status waiting oder pending. Rufen Sie Code-Scans auflisten auf, um den Fortschritt zu verfolgen, und Code-Scan-Befunde auflisten (gefiltert nach scan_id), um die Ergebnisse abzurufen, sobald der Scan den Status completed erreicht.
Der Scan wird dem aufrufenden Principal zugeordnet (dem Service-Benutzer oder PAT, der die Anfrage gestellt hat). Das Äquivalent mit Enterprise-Geltungsbereich ist Code-Scan starten (Enterprise).
Anfragefelder
repo_name(erforderlich): vollständiger Repository-Name, z. B.owner/repo. Das Repository muss bereits über die Git-Integration der Organisation zugänglich sein.host: Git-Host des Repositorys, falls er nicht abgeleitet werden kann.profile_id: anzuwendendes Scan-Profil. Verwenden Sie Ingestion-Scan starten für Profile imingest-Modus.scan_type: Typ des auszuführenden Scans. Wennprofile_idangegeben ist, muss er dem Scan-Typ des Profils entsprechen. Standardmäßig wird der Typ des Profils verwendet, bei Scans ohne Profilsecurity. Nicht sicherheitsbezogene Scan-Typen erfordern ein Profil.commit_sha: Commit, der vor dem Scannen ausgecheckt werden soll. Standardmäßig wird der aktuelle Stand des Standard-Branches des Repositorys verwendet.
Fehler
400, wennscan_typemit dem Profil in Konflikt steht oder ein nicht sicherheitsbezogenerscan_typeohne Profil angegeben wird.403, wenn die Organisation auf reine Ingestion-Scans beschränkt ist und kein Profil imingest-Modus angegeben wird.404, wenn das Repository oder Profil für die Organisation nicht sichtbar ist.409, wenn der Scan-Backlog der Organisation ausgelastet ist. Versuchen Sie es später erneut.
Autorisierungen
Servicebenutzer-Anmeldedaten (Präfix: cog_)
Pfadparameter
Organisations-ID (Präfix: org-)
"org-abc123def456"
Body
Request-Body zum Starten eines neuen Code-Scans.
Vollständiger Name des zu scannenden Repositorys.
Commit, der vor dem Scan ausgecheckt werden soll.
Git-Host des Repositorys, falls bekannt.
Scan-Profil, das auf den Scan angewendet werden soll.
Art des auszuführenden Scans. Muss dem Scan-Typ des Profils entsprechen, wenn ein Profil angegeben ist; standardmäßig wird der Typ des Profils verwendet, oder 'security' für Scans ohne Profil. Nicht sicherheitsbezogene Typen erfordern ein Profil und werden ohne eines abgelehnt.
security, performance, db-queries, test-coverage, dead-code, code-quality, telemetry, accessibility, general, migration-docs Antwort
Erfolgreiche Antwort
Ein einzelner Code-Scan.
Zeitpunkt, zu dem der Scan erstellt wurde (Unix-Sekunden).
Git-Host des Repositorys, falls bekannt.
Organisation, zu der der Scan gehört.
Profil, unter dem der Scan ausgeführt wurde, falls vorhanden.
Primäres Repository des Scans. Multi-Repo-Scans umfassen zusätzliche Repositorys, die hier nicht aufgeführt sind.
Eindeutige Kennung des Scans.
Typ des Scans, bei der Erstellung festgelegt.
security, performance, db-queries, test-coverage, dead-code, code-quality, telemetry, accessibility, general, migration-docs Scan-Status: waiting, pending, running, awaiting_user_input, completed, failed oder cancelled.
waiting, pending, running, awaiting_user_input, completed, failed, cancelled 
