API Reference

API Reference

Base URL: http://localhost:8000 (dev) / http://localhost:3000/api (Docker, via Nginx).

Real-time events: ws://localhost:8000/ws/events

Targets & scans

Method	Path	Description
POST	/api/targets	Register a target URL
GET	/api/targets	List targets
POST	/api/scans/start	Start a scan job
POST	/api/scans/{id}/stop	Cancel a running job
GET	/api/scans/{id}	Get job status + per-scanner progress
GET	/api/scans	List all jobs

Plugins

Method	Path	Description
GET	/api/plugins	List installed scanners with capabilities and manifest
POST	/api/plugins/reload	Rediscover entry points at runtime
GET	/api/plugins/health	Runtime health for all seen plugins
GET	/api/plugins/health/{name}	Health detail for one plugin
POST	/api/plugins/health/{name}/reset	Reset crash counters
GET	/api/plugins/audit	Plugin execution audit log
GET	/api/plugins/audit/stats	Per-plugin audit event counters
GET	/api/plugins/gateway/stats	Finding gateway accepted/rejected stats

Findings & proxy

Method	Path	Description
GET	/api/findings	List findings (?job_id=&severity=&limit=)
GET	/api/proxy/history	Proxy traffic history

Attack surface graph

Method	Path	Description
GET	/api/graph/summary	Attack surface graph summary
GET	/api/graph/nodes	Graph nodes (?type=&limit=)
GET	/api/graph/subgraph/{id}	Subgraph BFS from a node
GET	/api/graph/attack-chains	Finding-anchored attack chains
GET	/api/graph/parameter-reuse	Parameters shared across endpoints

Auth

Method	Path	Description
GET	/api/auth/profiles	Auth profiles
GET	/api/auth/sessions	Live auth sessions

Cluster / workers

Method	Path	Description
GET	/api/workers	Registered worker nodes (cluster mode)

Workflows

Method	Path	Description
GET	/api/workflows/definitions	List workflow definitions
POST	/api/workflows/definitions	Create workflow definition
POST	/api/workflows/definitions/{id}/run	Trigger a workflow manually
GET	/api/workflows/runs	List workflow run history
GET	/api/workflows/examples	Built-in example workflows
POST	/api/workflows/examples/seed	Seed the database with examples

Correlation

Method	Path	Description
GET	/api/correlation/summary	High-level counts across all findings
GET	/api/correlation/chains	Attack chains sorted by risk score desc
GET	/api/correlation/clusters	Endpoint clusters (host+path grouping)
GET	/api/correlation/duplicates	Duplicate/near-duplicate finding groups
GET	/api/correlation/lineage	Replay session → finding lineage
GET	/api/correlation/findings/{id}	All correlations anchored to a finding
POST	/api/correlation/run	Trigger full retroactive correlation pass

Observability

Method	Path	Description
GET	/api/observability/traces	List traces (?subsystem=&status=&limit=)
GET	/api/observability/traces/{id}	All spans in a trace
GET	/api/observability/traces/{id}/timeline	Waterfall timeline
GET	/api/observability/spans/{id}/lineage	Ancestor chain up to root
GET	/api/observability/spans/{id}/descendants	All child spans
GET	/api/observability/stats	Aggregate span counts per subsystem
GET	/api/observability/collector	Collector health (queue, drop rate)

System

Method	Path	Description
GET	/health	Health check
WS	/ws/events	Real-time event stream