Skip to main content
POST
/
project
/
{projectId}
/
github
/
start-scan
Start GitHub repository scan
curl --request POST \
  --url https://api-eu.cybedefend.com/project/{projectId}/github/start-scan \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "repositoryId": "uuid-value",
  "branch": "main"
}
'

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 associated with the GitHub repository

Example:

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

Body

application/json
​
repositoryId
string
required

Repository identifier

Example:

"uuid-value"

​
branch
string

Branch to scan (defaults to configured scan branch or repository default branch)

Example:

"main"

Response

Scan request accepted and processing asynchronously