メインコンテンツへスキップ
GET
コードスキャンの一覧

権限

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

動作

Enterprise 全体のコードスキャンを新しい順に返します。Start Code Scan で開始したスキャンの status をポーリングする際に利用します。状態は waiting → pending → running → completed (または failed / cancelled) の順に遷移します。awaiting_user_input はインタラクティブなスキャンにのみ適用されます。interactive: true を指定して開始した (または web app からインタラクティブに開始した) セキュリティスキャンは、脅威モデリングと調査の間にこの状態で一時停止し、ユーザーのレビューを待ちます。

フィルター

  • time_after / time_before: スキャンの作成時刻の範囲を指定する、UTC の秒単位の Unix タイムスタンプ。
  • repo_name: このリポジトリを対象とするスキャンのみ。対象リポジトリを含む複数リポジトリのスキャンにも一致します。
  • org_ids: 指定した組織内のスキャンのみ。
結果は不透明なカーソル (after / first) を使用してページネーションされます。単一の組織については、コードスキャンの一覧 (Organization) を使用してください。

承認

Authorization
string
header
必須

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

クエリパラメータ

time_before
integer | null
time_after
integer | null
after
string | null
first
integer
デフォルト:100
必須範囲: 1 <= x <= 200
scan_type
enum<string> | null

このスキャンタイプのスキャンのみに絞り込みます。

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

このリポジトリを対象に含むスキャンのみに絞り込みます。複数のリポジトリを対象とするスキャンでは、このリポジトリがプライマリリポジトリでなくても一致するため、返されるアイテムのrepo_nameが異なる場合があります。

org_ids
string[] | null

これらの組織内のスキャンのみに絞り込みます。

レスポンス

成功レスポンス

items
CodeScanResponse · object[]
必須
end_cursor
string | null

次のページを取得するためのカーソル。これが最後のページの場合は None。

has_next_page
boolean
デフォルト:false

このページの後に利用可能なアイテムがあるかどうか。

total
integer | null

任意の合計件数(パフォーマンスのため省略される場合があります)。