Skip to main content
GET
/
scan
/
{scan_id}
Get Scan
curl --request GET \
  --url https://www.corgea.app/api/v1/scan/{scan_id} \
  --header 'CORGEA-TOKEN: <api-key>'
{
  "status": "ok",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project": "<string>",
  "repo": "<string>",
  "branch": "<string>",
  "scan_status": "completed",
  "engine": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
CORGEA-TOKEN
string
header
required

API key for authentication

Path Parameters

​
scan_id
string<uuid>
required

The ID of the scan

Response

Scan details retrieved successfully

​
status
string
Example:

"ok"

​
id
string<uuid>
​
project
string
​
repo
string
​
branch
string
​
scan_status
enum<string>
Available options:
completed,
in_progress,
failed
​
engine
string
​
created_at
string<date-time>
⌘I