Skip to main content
GET
コードスキャンを一覧表示

権限

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

動作

Enterprise 全体のコードスキャンを新しい順に返します。Start Code Scan で開始したスキャンの status をポーリングする際に利用します。状態は waitingpendingrunningcompleted (または failed / cancelled) の順に遷移します。awaiting_user_input は web app から開始したインタラクティブなスキャンにのみ適用され、API で開始したスキャンはこの状態にはなりません。

フィルター

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

承認

Authorization
string
header
必須

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

クエリパラメータ

time_before
integer | null
time_after
integer | null
after
string | null
first
integer
デフォルト:100
必須範囲: 1 <= x <= 200
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

任意の合計件数(パフォーマンスのため省略可能)。