メインコンテンツへスキップ
POST
コードスキャンを開始

権限

Enterprise レベルで UseAccountCodeScans 権限を持つ、サービスユーザーまたはパーソナルアクセストークンが必要です。

動作

指定した組織内のリポジトリ (repo_name) または複数のリポジトリ (repos) に対する新しいコードスキャンをキューに追加します。スキャンはスキャンディスパッチャーによって非同期で開始されます。レスポンスとして、初期 status が waiting または pending のスキャンレコードが返されます。コードスキャンの一覧をポーリングして進行状況を追跡し、スキャンが completed になったら、scan_id でフィルタリングしたコードスキャン検出結果の一覧で結果を確認します。 スキャンは、呼び出し元のプリンシパル (リクエストを行ったサービスユーザーまたは PAT) に紐付けられます。

リクエストフィールド

repo_name と repos のいずれか一方のみを指定してください。
  • repo_name: 完全なリポジトリ名 (例: owner/repo) 。リポジトリには、組織の Git 統合を通じてすでにアクセスできる必要があります。
  • host: 推測できない場合に指定する、リポジトリの Git ホスト。
  • repos: 1 つのマルチリポジトリスキャンの対象とするリポジトリ。repo_name と任意の host を持つオブジェクトのリストとして指定します (最大 200 件) 。最初の項目がスキャンのプライマリリポジトリになります。
  • profile_id: 適用するスキャンプロファイル。ingest モードのプロファイルには、Start Ingestion Scanを使用します。
  • scan_type: 実行するスキャンの種類。profile_id を指定する場合は、プロファイルのスキャンタイプと一致する必要があります。デフォルトはプロファイルの種類です。プロファイルを指定しないスキャンでは security がデフォルトになります。セキュリティ以外のスキャンタイプにはプロファイルが必要です。
  • commit_sha: スキャン前にチェックアウトするコミット。デフォルトはリポジトリのデフォルトブランチの HEAD です。
  • effort: normal (デフォルト) では、モデルの推論レベルを抑え、より大きな単位でまとめて調査を行います。deep ではパイプライン全体を実行します。
  • interactive: true の場合、スキャンは脅威モデリングと調査の間で awaiting_user_input 状態となって一時停止し、ユーザーのレビューを待ちます。デフォルトは false です。インタラクティブレビューに対応しているのはセキュリティスキャンのみで、その他のスキャンタイプはユーザーの操作なしで実行されます。
  • platform: スキャンのセッションを実行する場所。組織に設定されたプラットフォームラベル (例: linux、windows、macos) または outpost プールの名前のいずれかを指定します (大文字と小文字は区別されません) 。名前が両方に一致する場合は、プラットフォームが優先されます。デフォルトは組織のデフォルト設定です。

エラー

  • scan_type がプロファイルと競合している場合、プロファイルを指定せずにセキュリティ以外の scan_type を指定した場合、または platform が設定済みのプラットフォームラベルや outpost プールのいずれとも一致しない場合は 400 (エラー本文に指定可能な値の一覧が含まれます) 。
  • 組織が取り込み専用スキャンに制限されており、ingest モードのプロファイルが指定されていない場合は 403。
  • 組織、リポジトリ、またはプロファイルが Enterprise アカウントから参照できない場合は 404。
  • 組織のスキャンバックログが上限に達している場合は 409。後で再試行してください。
  • repo_name と repos の両方を指定した場合、またはどちらも指定しなかった場合、あるいは repos が空の場合は 422。

承認

Authorization
string
header
必須

サービスユーザーの credential(プレフィックス: cog_)

パスパラメータ

org_id
string
必須

組織 ID(プレフィックス: org-)

例:

"org-abc123def456"

ボディ

application/json

新しいコードスキャンを開始するためのリクエストボディ。

repo_name
string | null

スキャン対象のリポジトリのフルネーム。repo_name または repos のいずれか一方のみを指定してください。

host
string | null

既知の場合の、リポジトリの Git ホスト。

repos
ScanRepoRequest · object[] | null

1 回のスキャンの対象となるリポジトリ。最初の項目がスキャンのプライマリリポジトリです。repo_name または repos のいずれか一方だけを指定してください。

Maximum array length: 500
profile_id
string | null

スキャンに適用するスキャンプロファイル。

scan_type
enum<string> | null

実行するスキャンの種類。プロファイルを指定する場合はそのスキャンタイプと一致する必要があります。デフォルトはプロファイルのタイプ、プロファイルなしのスキャンでは 'security' です。セキュリティ以外のタイプにはプロファイルが必要で、プロファイルなしでは拒否されます。

利用可能なオプション:
security,
performance,
db-queries,
test-coverage,
dead-code,
code-quality,
cleanup,
telemetry,
accessibility,
compliance,
general,
migration-docs,
red-team
commit_sha
string | null

スキャン前にチェックアウトするコミット。

effort
enum<string> | null

スキャンの実行レベル:'normal'(デフォルト)はモデルの推論量を抑え、より大きなバッチで調査します。'deep' はパイプライン全体を実行します。

利用可能なオプション:
normal,
deep
interactive
boolean
デフォルト:false

true の場合、脅威モデリングと調査の間でスキャンを一時停止し、ユーザーの確認を待ちます。

devin_mode
enum<string> | null

スキャンのセッションをrunするエージェント:'fusion' または 'swe-2'(スキャンの実行レベルが 'deep' の場合は SWE-2 Max、'normal' の場合は SWE-2 High)。組織でそのモードが有効になっている場合にのみ適用されます。有効になっていない場合や省略した場合は、デフォルトのエージェントでスキャンがrunされます。

利用可能なオプション:
fusion,
swe-2
platform
string | null

スキャンのセッションの実行先。組織に設定されたプラットフォームラベル(例:'linux', 'windows', 'macos')またはアウトポスト(BYOB)プールの名前を指定します。大文字と小文字は区別しません。名前が両方に一致する場合はプラットフォームが優先されます。省略すると組織のデフォルトが適用されます。認識されない値は 400 エラーで拒否され、エラーボディに利用可能なプラットフォームラベルとアウトポストプール名が列挙されます。

Maximum string length: 128
locale
string | null

スキャンのユーザー向け出力(検出結果のタイトル、説明、レポート)に使用する BCP-47 言語タグ(例:'ja')。省略した場合は英語。

レスポンス

成功レスポンス

1 件のコードスキャン。

scan_id
string
必須

スキャンの一意の識別子。

org_id
string
必須

スキャンが属する組織。

repo_name
string
必須

スキャンの主要リポジトリ。複数リポジトリを対象とするスキャンには、ここに記載されていない追加のリポジトリも含まれます。

host
string | null
必須

リポジトリの Git ホスト(判明している場合)。

status
enum<string>
必須

スキャンのステータス: waiting、pending、running、awaiting_user_input、completed、failed、または cancelled。

利用可能なオプション:
waiting,
pending,
running,
awaiting_user_input,
completed,
failed,
cancelled
profile
CodeScanProfileResponse · object | null
必須

スキャンの実行に使用されたプロファイル(存在する場合)。

scan_type
enum<string>
必須

作成時に記録されるスキャンの種類。

利用可能なオプション:
security,
performance,
db-queries,
test-coverage,
dead-code,
code-quality,
cleanup,
telemetry,
accessibility,
compliance,
general,
migration-docs,
red-team
created_at
integer
必須

スキャンの作成日時(Unix 秒)。

effort
enum<string>
必須

スキャンの実行レベル:'normal' はモデルの推論量を抑え、より大きなバッチで調査します。'deep' はパイプライン全体を実行します。

利用可能なオプション:
normal,
deep
url
string
必須

Devin webapp 内のスキャンページの URL。

repo_full_name
string | null

ホスト名を含むプライマリリポジトリの識別情報(例:github.com/org/repo)。Git ホストを持たない Perforce デポの場合は Null。

platform
string | null

スキャンのセッションを実行するホスト型プラットフォームのラベル。スキャンがアウトポストプールまたは組織のデフォルトの実行先で実行される場合は Null。

outpost_pool_id
string | null

スキャンのセッションを実行するアウトポストプール(設定されている場合)。

attachments
CodeScanAttachmentResponse · object[]

スキャンの作成時にアタッチされたファイル。