Skip to main content
POST
Start Harbor container scan

Path Parameters

projectId
string<uuid>
required

CybeDefend project ID

Example:

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

Body

application/json
credentialId
string
required

Credential ID to use for authentication

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

imageName
string
required

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

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:

Response

Scan started successfully - processing asynchronously

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