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",
  "branch": "main",
  "privateScan": false,
  "vulnerabilityTypes": [
    "CRITICAL",
    "HIGH"
  ],
  "registryAuth": {
    "registryType": "gitlab",
    "registryUrl": "registry.gitlab.com",
    "credentialId": "123e4567-e89b-12d3-a456-426614174000",
    "username": "gitlab+deploy-token-123",
    "password": "gldt-xxxxxxxxxxxx",
    "awsRegion": "eu-west-1",
    "awsAccessKeyId": "<string>",
    "awsSecretAccessKey": "<string>",
    "gcpServiceAccountKey": "<string>",
    "gcpProjectId": "my-gcp-project"
  },
  "sourceType": "manual"
}
'
{
  "success": true,
  "message": "<string>",
  "scanId": "<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

The unique identifier of the project to scan

Example:

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

Body

application/json
​
imageToScan
string
required

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

Example:

"node:18-alpine"

​
branch
string

Branch name for tracking purposes

Example:

"main"

​
privateScan
boolean
default:false

Whether the scan is private.

​
vulnerabilityTypes
string[]

Types of vulnerabilities to look for.

Example:
["CRITICAL", "HIGH"]
​
registryAuth
object

Registry authentication for private registries. If not provided, public registry is assumed.

​
sourceType
enum<string>
default:manual

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

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

"manual"

Response

Container scan initiated successfully

​
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