Skip to main content
POST
/
project
/
{projectId}
/
scan
/
start
Start a scan
curl --request POST \
  --url https://api-eu.cybedefend.com/project/{projectId}/scan/start \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "branch": "main",
  "sourceType": "manual"
}
'
{
  "success": true,
  "message": "<string>",
  "scanId": "<string>",
  "detectedLanguages": [
    "<string>"
  ]
}

Authorizations

​
x-api-key
string
header
required

API Key for authentication. You can generate an API key from your personal settings.

Path Parameters

​
projectId
string<uuid>
required

The unique identifier of the project to scan

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json
​
branch
string

Branch name being scanned (for GitHub/GitLab integrations). If not provided, scan is not associated with a specific branch.

Example:

"main"

​
sourceType
enum<string>
default:manual

Source type of the scan (manual, cli, github, gitlab, jetbrains, vscode). Defaults to manual if not provided.

Available options:
manual,
cli,
github,
gitlab,
jetbrains,
vscode
Example:

"manual"

Response

Scan initiated successfully - returns signed URL for upload

​
success
boolean
required

Whether the scan started successfully

​
message
string
required

Message describing the scan start result

​
scanId
string

The unique identifier of the created scan

​
detectedLanguages
string[]

Detected languages (if any) during scan initialization