Skip to main content
POST
/
start-scan
Start New Scan
curl --request POST \
  --url https://www.corgea.app/api/v1/start-scan \
  --header 'CORGEA-TOKEN: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --form scan_type=blast \
  --form 'files=<string>' \
  --form 'repo_url=<string>' \
  --form 'branch=<string>' \
  --form 'sha=<string>' \
  --form files.items='@example-file'
{
  "message": "Successfully initiated upload at /tmp/uploads/transfer_id",
  "transfer_id": "c9b0a8c7-f9b4-4c10-9d58-cd4c7e1c9c52",
  "status": "OK"
}

Authorizations

​
CORGEA-TOKEN
string
header
required

API key for authentication

Body

multipart/form-data
​
scan_type
enum<string>
default:blast
required

Currently only blast scan is supported

Available options:
blast
​
files
file[]
required

Source code files to be scanned. For BLAST scans, only a single file is currently supported.

​
repo_url
string

The URL of the repository (optional)

​
branch
string

The branch to be scanned (optional)

​
sha
string

The commit SHA to be scanned (optional)

Response

Scan initiated successfully

​
message
string
Example:

"Successfully initiated upload at /tmp/uploads/transfer_id"

​
transfer_id
string<uuid>
Example:

"c9b0a8c7-f9b4-4c10-9d58-cd4c7e1c9c52"

​
status
enum<string>
Available options:
OK
Example:

"OK"