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

権限

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

動作

組織内の repo_name に対する新しいコードスキャンをキューに登録します。スキャンはスキャンディスパッチャーによって非同期で開始され、レスポンスとして初期 statuswaiting または pending のスキャンレコードが返されます。List Code Scans をポーリングして進行状況を追跡し、スキャンが completed になったら、scan_id でフィルタリングした List Code Scan Findings で結果を確認します。 スキャンは、呼び出し元のプリンシパル (リクエストを行ったサービスユーザーまたは PAT) に紐付けられます。Enterprise スコープで同等の機能を利用するには、Start Code Scan (Enterprise) を参照してください。

リクエストフィールド

  • repo_name (必須) : 完全なリポジトリ名 (例: owner/repo) 。リポジトリには、組織の Git 統合を通じてあらかじめアクセスできる必要があります。
  • host: 自動的に判別できない場合のリポジトリの Git ホスト。
  • profile_id: 適用するスキャンプロファイルingest モードのプロファイルには、Start Ingestion Scanを使用します。
  • scan_type: 実行するスキャンタイプ。profile_id を指定する場合は、プロファイルのスキャンタイプと一致している必要があります。デフォルトはプロファイルのスキャンタイプで、プロファイルなしのスキャンでは security です。セキュリティ以外のスキャンタイプにはプロファイルが必要です。
  • commit_sha: スキャン前にチェックアウトするコミット。デフォルトはリポジトリのデフォルトブランチの先頭コミットです。

エラー

  • 400: scan_type がプロファイルと矛盾している場合、またはプロファイルなしでセキュリティ以外の scan_type が指定された場合。
  • 403: 組織が取り込み専用スキャンに制限されており、ingest モードのプロファイルが指定されていない場合。
  • 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