Get Scan

Retrieves details of a specific scan

GET /scan/{scan_id}

Get Scan

cURL

curl --request GET \
  --url https://www.corgea.app/api/v1/scan/{scan_id} \
  --header 'CORGEA-TOKEN: <api-key>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project": "<string>",
  "repo": "<string>",
  "branch": "<string>",
  "status": "scanning",
  "engine": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "time_taken": 123,
  "git_sha": "<string>",
  "worktree_dirty": true,
  "metadata": {}
}

Authorizations

CorgeaTokenBearerAuth

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

200

application/json

Scan details retrieved successfully

id · string<uuid>

project · string

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