Skip to main content
POST
Code-Scan starten

Berechtigungen

Erfordert einen Service-Benutzer oder ein Personal Access Token mit der Berechtigung UseAccountCodeScans auf Unternehmensebene.

Verhalten

Stellt einen neuen Code-Scan für repo_name in der angegebenen 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 regelmäßig Code-Scans auflisten auf, um den Fortschritt zu verfolgen, und verwenden Sie 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).

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 automatisch ermittelt werden kann.
  • profile_id: ein anzuwendendes Scan-Profil. Verwenden Sie Ingestion-Scan starten für Profile im Modus ingest.
  • scan_type: Typ des auszuführenden Scans. Bei Angabe von profile_id muss er dem Scan-Typ des Profils entsprechen. Standardmäßig wird der Typ des Profils verwendet, bei Scans ohne Profil security. Nicht sicherheitsbezogene Scan-Typen erfordern ein Profil.
  • commit_sha: Commit, der vor dem Scan ausgecheckt werden soll. Standardmäßig wird der HEAD des Standard-Branches des Repositorys verwendet.

Fehler

  • 400, wenn scan_type nicht mit dem Profil übereinstimmt oder ein nicht sicherheitsbezogener scan_type ohne Profil angegeben wird.
  • 403, wenn die Organisation auf reine Ingestion-Scans beschränkt ist und kein Profil im ingest-Modus angegeben wird.
  • 404, wenn die Organisation, das Repository oder das Profil für das Enterprise-Konto nicht sichtbar ist.
  • 409, wenn das Scan-Backlog der Organisation seine Kapazitätsgrenze erreicht hat. 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

Request-Body zum Starten eines neuen Code-Scans.

repo_name
string
erforderlich

Vollständiger Name des zu scannenden Repositorys.

commit_sha
string | null

Commit, der vor dem Scan ausgecheckt werden soll.

host
string | null

Git-Host des Repositorys, falls bekannt.

profile_id
string | null

Scan-Profil, das auf den Scan angewendet werden soll.

scan_type
enum<string> | null

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.

Verfügbare Optionen:
security,
performance,
db-queries,
test-coverage,
dead-code,
code-quality,
telemetry,
accessibility,
general,
migration-docs

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