Skip to main content
POST
Ingestion-Scan starten

Berechtigungen

Erfordert einen Service-Benutzer oder ein persönliches Zugriffstoken mit der Berechtigung UseCodeScans auf Organisationsebene.

Verhalten

Stellt einen Code-Scan im Ingestion-Modus in die Warteschlange. Statt Issues von Grund auf zu erkennen, übernimmt ein Ingestion-Scan extern erstellte Befunde (zum Beispiel aus einem SAST-Bericht) und lässt sie von Devin anhand des Repositorys triagieren und validieren. Der Scan wird vom Scan-Dispatcher asynchron gestartet und dem aufrufenden Principal zugeordnet. Das Pendant im Enterprise-Geltungsbereich ist Ingestion-Scan starten (Enterprise).

Anfragefelder

  • repo_name (erforderlich): vollständiger Name des Repositorys, z. B. owner/repo.
  • profile_id (erforderlich): ein Scan-Profil im Modus ingest. Ein Profil im Modus discover wird mit 400 abgewiesen.
  • host: Git-Host des Repositorys, sofern er nicht abgeleitet werden kann.
  • attachment_urls: Devin-Anhang-URLs (zum Beispiel ein exportierter Scannerbericht), die dem Scan als Eingabe bereitgestellt werden. Laden Sie Dateien zuerst über die Attachments API hoch, wofür die Berechtigung UseDevinSessions erforderlich ist.

Fehler

  • 400, wenn profile_id kein Profil im Ingestion-Modus ist.
  • 404, wenn das Repository oder Profil für die Organisation nicht sichtbar ist.
  • 409, wenn die Scan-Warteschlange der Organisation ausgelastet ist. Versuchen Sie es später erneut.

Autorisierungen

Authorization
string
header
erforderlich

Servicebenutzer-Anmeldedaten (Präfix: cog_)

Pfadparameter

org_id
string
erforderlich

Organisations-ID (Präfix: org-)

Beispiel:

"org-abc123def456"

Body

application/json

Anfragetext zum Starten eines Code-Scans im Ingestion-Modus.

Akzeptiert nur ein Scanprofil für die Ingestion (Ingest-Modus): Das Profil wird für das angegebene Repository ausgeführt.

profile_id
string
erforderlich

Auszuführendes Scanprofil im Ingestion-Modus. Muss ein Ingest-Profil sein; Nicht-Ingest-Profile werden mit 400 abgewiesen.

repo_name
string
erforderlich

Vollständiger Name des zu scannenden Repositorys.

attachment_urls
string<uri>[] | null

Devin-Anhang-URLs, die dem Scan bereitgestellt werden, z. B. über die Attachments-API hochgeladene Dateien. Die Anhänge müssen zu der gescannten Organisation gehören.

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

Git-Host des Repositorys, falls bekannt.

Antwort

Erfolgreiche Antwort

Ein einzelner Code-Scan.

created_at
integer
erforderlich

Zeitpunkt, zu dem der Scan erstellt wurde (Unix-Sekunden).

host
string | null
erforderlich

Git-Host des Repositorys, falls bekannt.

org_id
string
erforderlich

Organisation, zu der der Scan gehört.

profile
CodeScanProfileResponse · object | null
erforderlich

Profil, unter dem der Scan ausgeführt wurde, falls vorhanden.

repo_name
string
erforderlich

Primäres Repository des Scans. Multi-Repo-Scans umfassen zusätzliche Repositorys, die hier nicht aufgeführt sind.

scan_id
string
erforderlich

Eindeutige Kennung des Scans.

scan_type
enum<string>
erforderlich

Typ des Scans, bei der Erstellung festgelegt.

Verfügbare Optionen:
security,
performance,
db-queries,
test-coverage,
dead-code,
code-quality,
telemetry,
accessibility,
general,
migration-docs
status
enum<string>
erforderlich

Scan-Status: waiting, pending, running, awaiting_user_input, completed, failed oder cancelled.

Verfügbare Optionen:
waiting,
pending,
running,
awaiting_user_input,
completed,
failed,
cancelled