Skip to main content
POST
/
integrations
/
github-container-registry
/
project
/
{projectId}
/
scan
Start GitHub Container Registry scan
curl --request POST \
  --url https://api-eu.cybedefend.com/integrations/github-container-registry/project/{projectId}/scan \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "imageName": "my-app:v1.0.0",
  "branch": "main",
  "privateScan": false,
  "severities": [
    "CRITICAL",
    "HIGH"
  ]
}
'
{
  "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

CybeDefend project ID

Example:

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

Body

application/json

Container scan configuration

​
imageName
string
required

Image name with tag to scan (e.g., "my-app:v1.0.0" or "my-app@sha256:...")

Example:

"my-app:v1.0.0"

​
branch
string

Branch name for tracking purposes

Example:

"main"

​
privateScan
boolean
default:false

Whether the scan results should be private

​
severities
string[]

Vulnerability severities to include

Example:
["CRITICAL", "HIGH"]

Response

Scan request accepted and queued for processing

​
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