Skip to main content
POST
コードスキャンを開始

権限

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

動作

指定した組織内の repo_name に対する新しいコードスキャンをキューに追加します。スキャンはスキャンディスパッチャーによって非同期で開始されます。レスポンスとして、初期 statuswaiting または 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。後で再試行してください。

承認

Authorization
string
header
必須

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

パスパラメータ

org_id
string
必須

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

:

"org-abc123def456"

ボディ

application/json

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

repo_name
string
必須

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

commit_sha
string | null

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

host
string | null

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

profile_id
string | null

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

scan_type
enum<string> | null

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

利用可能なオプション:
security,
performance,
db-queries,
test-coverage,
dead-code,
code-quality,
telemetry,
accessibility,
general,
migration-docs

レスポンス

成功レスポンス

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