Skip to main content
GET
Get Scan

Authorizations

CORGEA-TOKEN
string
header
required

API key for authentication API tokens belonging to inactive users are rejected.

Path Parameters

scan_id
string<uuid>
required

The ID of the scan

Response

Scan details retrieved successfully

id
string<uuid>
project
string
project_id
integer

Numeric ID of the project associated with the scan.

repo
string
branch
string
status
enum<string>

Scan progress. "scanning" and "processing" are in-flight states, "complete" means the scan finished, and "incomplete" means it failed.

Available options:
scanning,
processing,
complete,
incomplete
engine
string
created_at
string<date-time>
time_taken
number | null

Scan duration in seconds, or null until the scan finishes processing

git_sha
string | null

Commit SHA associated with the scan

worktree_dirty
boolean | null

Whether the scan included uncommitted local changes. Null for scans created without a worktree state signal.

metadata
object | null

User-supplied metadata associated with the scan

source
enum<string> | null

How the scan was started; null when its origin is unknown.

Available options:
api,
cli,
vscode,
vs2022,
intellij,
github_app,
gitlab,
azure_devops,
bitbucket,
harness,
scheduled,
manual,
demo,
web_upload,
other,
null
triggered_by
object | null

User who triggered the scan. Null for source-control integration scans; this is not the pull request author. The email can be used with the triggered_by filter.

pull_request_id
string | null

Pull request or merge request identifier; null for scans without one.