コードスキャンを開始(Devin API)
v3 Enterprise API を使用して、組織内のリポジトリに対する新しい Devin コードスキャンを開始します。必要に応じて、スキャンプロファイルまたはコミットを指定できます
権限
UseAccountCodeScans 権限を持つ、サービスユーザーまたはパーソナルアクセストークンが必要です。
動作
repo_name に対する新しいコードスキャンをキューに追加します。スキャンはスキャンディスパッチャーによって非同期で開始されます。レスポンスとして、初期 status が waiting または pending のスキャンレコードが返されます。コードスキャンの一覧をポーリングして進行状況を追跡し、スキャンが completed になったら、scan_id でフィルタリングしたコードスキャン検出結果の一覧で結果を確認します。
スキャンは、呼び出し元のプリンシパル (リクエストを行ったサービスユーザーまたは PAT) に紐付けられます。
リクエストフィールド
repo_name(必須) : 完全なリポジトリ名 (例:owner/repo) 。リポジトリには、組織の Git 統合を通じてすでにアクセスできる必要があります。host: 推測できない場合に指定する、リポジトリの Git ホスト。profile_id: 適用するスキャンプロファイル。ingestモードのプロファイルには、Start Ingestion Scanを使用します。scan_type: 実行するスキャンの種類。profile_idを指定する場合は、プロファイルのスキャンタイプと一致する必要があります。デフォルトはプロファイルの種類です。プロファイルを指定しないスキャンではsecurityがデフォルトになります。セキュリティ以外のスキャンタイプにはプロファイルが必要です。commit_sha: スキャン前にチェックアウトするコミット。デフォルトはリポジトリのデフォルトブランチの HEAD です。
エラー
scan_typeがプロファイルと競合している場合、またはプロファイルを指定せずにセキュリティ以外のscan_typeを指定した場合は400。- 組織が取り込み専用スキャンに制限されており、
ingestモードのプロファイルが指定されていない場合は403。 - 組織、リポジトリ、またはプロファイルが Enterprise アカウントから参照できない場合は
404。 - 組織のスキャンバックログが上限に達している場合は
409。後で再試行してください。
承認
サービスユーザーの認証情報(接頭辞: cog_)
パスパラメータ
組織 ID(プレフィックス: org-)
"org-abc123def456"
ボディ
新しいコードスキャンを開始するためのリクエストボディ。
スキャン対象のリポジトリの完全名。
スキャン前にチェックアウトするコミット。
既知の場合、リポジトリの Git ホスト。
スキャンに適用するスキャンプロファイル。
実行するスキャンのタイプ。プロファイルが指定されている場合は、そのスキャンタイプと一致する必要があります。デフォルトはプロファイルのタイプ、またはプロファイルなしのスキャンでは 'security' です。セキュリティ以外のタイプにはプロファイルが必要で、プロファイルなしでは拒否されます。
security, performance, db-queries, test-coverage, dead-code, code-quality, telemetry, accessibility, general, migration-docs レスポンス
成功レスポンス
1件のコードスキャン。
スキャンの作成日時(Unix秒)。
既知の場合のリポジトリの Git ホスト。
スキャンが属する組織。
スキャンの実行時に使用されたプロファイル(ある場合)。
スキャンの主要なリポジトリ。マルチリポジトリスキャンには、ここに記載されていない追加のリポジトリも含まれます。
スキャンの一意の識別子。
作成時に記録されるスキャンのタイプ。
security, performance, db-queries, test-coverage, dead-code, code-quality, telemetry, accessibility, general, migration-docs スキャンのステータス: waiting、pending、running、awaiting_user_input、completed、failed、または cancelled。
waiting, pending, running, awaiting_user_input, completed, failed, cancelled 
