Skip to main content
POST
/
project
/
{projectId}
/
scan
/
container
/
start
Start a container scan
curl --request POST \
  --url https://us.cybedefend.com/project/{projectId}/scan/container/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "imageToScan": "node:18-alpine",
  "privateScan": false,
  "vulnerabilityTypes": [
    "CRITICAL",
    "HIGH"
  ]
}
'
{
  "success": true,
  "message": "<string>",
  "detectedLanguages": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
projectId
string<uuid>
required

Project unique identifier

Body

application/json
​
imageToScan
string
required

The Docker image to scan (e.g., "alpine:latest")

Example:

"node:18-alpine"

​
privateScan
boolean
default:false

Whether the scan is private.

​
vulnerabilityTypes
string[]

Types of vulnerabilities to look for.

Example:
["CRITICAL", "HIGH"]

Response

Container scan started successfully

​
success
boolean
required

Whether the scan started successfully

​
message
string
required

Message describing the scan start result

​
detectedLanguages
string[]

Detected languages (if any) during scan initialization