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

権限

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

動作

組織のコードスキャンを新しい順に返します。Start Code Scan で開始したスキャンの status をポーリングする際に使用します。ステータスは waitingpendingrunningcompleted (または failed / cancelled) の順に遷移します。awaiting_user_input は web app から開始した対話型スキャンにのみ適用され、API で開始したスキャンはこの状態になりません。Enterprise 内のすべての組織のスキャンを一覧表示するには、List Code Scans (Enterprise) を使用します。

フィルター

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

承認

Authorization
string
header
必須

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

パスパラメータ

org_id
string
必須

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

:

"org-abc123def456"

クエリパラメータ

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

このリポジトリをスキャンしたスキャンに絞り込みます。リポジトリがスキャンの主要リポジトリでない場合でも、複数リポジトリを対象としたスキャンに一致するため、返されるアイテムの repo_name が異なる場合があります。

レスポンス

成功レスポンス

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

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

has_next_page
boolean
デフォルト:false

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

total
integer | null

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