Sign in

v2

latestOpenAPI 3.1.0AGPL-3.0raw.githubusercontent.com2026-08-01312535.8 KB
scans

Create scan

Create and start a new security scan against a target URL. The scan runs asynchronously — use the status endpoint or WebSocket to track progress.

post/api/scans

Request body

target_urlstring uri required

Target URL to scan

scan_typestring

Scan type: full, hunter, manager, or focused agent names

scan_depth'' | 'quick' | 'standard' | 'thorough'

Exploitation depth: quick, standard, thorough

safe_modeboolean nullable

Override global safe mode setting

max_depthinteger

Maximum crawl depth

max_urlsinteger

Maximum URLs to crawl

resumeboolean

Resume a previous scan

use_verticalboolean

Use vertical specialized agents

focused_agentsstring[]

List of focused agent names

paramstring nullable

Specific parameter to target

Example request

{
  "target_url": "https://example.com",
  "scan_type": "full"
}

Response

Scan created and started

scan_idinteger
targetstring
status'PENDING' | 'INITIALIZING' | 'RUNNING' | 'PAUSED' | 'COMPLETED' | 'STOPPED' | 'FAILED'

Scan lifecycle status

progressinteger
uptime_secondsnumber nullable
findings_countinteger
active_agentstring nullable
phasestring nullable
origin'cli' | 'web' | 'unknown'

Where the scan was launched from