Skip to main content
POST
取り込みスキャンを開始

権限

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

動作

インジェストモードのコードスキャンをキューに登録します。インジェストスキャンでは、問題を一から検出するのではなく、外部で生成された検出結果 (たとえば SAST レポート) を取り込み、Devin がリポジトリに照らしてトリアージと検証を行います。スキャンはスキャンディスパッチャーによって非同期で起動され、呼び出し元のプリンシパルに関連付けられます。

リクエストフィールド

  • repo_name (必須) :完全なリポジトリ名 (例:owner/repo) 。
  • profile_id (必須) :ingestモードのスキャンプロファイルdiscoverモードのプロファイルを指定すると、400が返されます。
  • host:推測できない場合に指定するリポジトリの Git ホスト。
  • attachment_urls:スキャンに与える Devin の添付ファイル URL (エクスポートしたスキャナーレポートなど) 。最初にattachments APIでファイルをアップロードしてください。

エラー

  • 400: profile_id がインジェストモードのプロファイルではない場合。
  • 404: 組織、リポジトリ、またはプロファイルがEnterpriseアカウントから参照できない場合。
  • 409: 組織のスキャンバックログが上限に達している場合。後で再試行してください。

承認

Authorization
string
header
必須

サービスユーザーの認証情報(接頭辞: cog_)

パスパラメータ

org_id
string
必須

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

:

"org-abc123def456"

ボディ

application/json

取り込みモードのコードスキャンを開始するためのリクエストボディ。

取り込み(ingest-mode)スキャンプロファイルのみを受け付けます。プロファイルは指定されたリポジトリに対して実行されます。

profile_id
string
必須

実行する取り込みモードのスキャンプロファイル。取り込みプロファイルである必要があります。取り込み以外のプロファイルは 400 で拒否されます。

repo_name
string
必須

スキャン対象のリポジトリの完全名。

attachment_urls
string<uri>[] | null

スキャンに指定する Devin 添付ファイルの URL(例: attachments API を介してアップロードされたファイル)。添付ファイルは、スキャン対象の組織に属している必要があります。

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

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

レスポンス

成功レスポンス

1件のコードスキャン。

created_at
integer
必須

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

host
string | null
必須

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

org_id
string
必須

スキャンが属する組織。

profile
CodeScanProfileResponse · object | null
必須

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

repo_name
string
必須

スキャンの主要なリポジトリ。マルチリポジトリスキャンには、ここに記載されていない追加のリポジトリも含まれます。

scan_id
string
必須

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

scan_type
enum<string>
必須

作成時に記録されるスキャンのタイプ。

利用可能なオプション:
security,
performance,
db-queries,
test-coverage,
dead-code,
code-quality,
telemetry,
accessibility,
general,
migration-docs
status
enum<string>
必須

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

利用可能なオプション:
waiting,
pending,
running,
awaiting_user_input,
completed,
failed,
cancelled