メインコンテンツへスキップ
GET
スキャンを取得

承認

CORGEA-TOKEN
string
header
必須

認証用のAPIキー 無効なユーザーのAPIトークンは拒否されます。

パスパラメータ

scan_id
string<uuid>
必須

スキャンID

レスポンス

スキャンの詳細を正常に取得しました

id
string<uuid>
project
string
repo
string
branch
string
status
enum<string>

スキャンの進行状況。「scanning」と「processing」は実行中、「complete」は完了、「incomplete」は失敗を示します。

利用可能なオプション:
scanning,
processing,
complete,
incomplete
engine
string
created_at
string<date-time>
time_taken
number | null

スキャン所要時間(秒)。スキャン処理が完了するまではnullです

git_sha
string | null

スキャンに関連付けられたコミットSHA

worktree_dirty
boolean | null

スキャンにコミットされていないローカルの変更が含まれていたかどうか。ワークツリーの状態情報なしで作成されたスキャンではnullです。

metadata
object | null

スキャンに関連付けられたユーザー指定のメタデータ

source
enum<string> | null

スキャンの開始元を示します。不明な場合はnullです。

利用可能なオプション:
api,
cli,
vscode,
vs2022,
intellij,
github_app,
gitlab,
azure_devops,
bitbucket,
harness,
scheduled,
manual,
demo,
web_upload,
other,
null
triggered_by
object | null

スキャンを開始したユーザー。ソースコード管理の連携によるスキャンではnullとなり、プルリクエストの作成者を示すものではありません。メールアドレスはtriggered_byフィルターに使用できます。

pull_request_id
string | null

プルリクエストまたはマージリクエストの識別子。関連付けがないスキャンではnullです。