Skip to content

API and Dashboard

Krishnendu Bhattacherjee edited this page Nov 10, 2026 · 2 revisions

API and Dashboard

The analyst dashboard exposes alert, timeline, intelligence, detection and hunting views. Analyst review is stored separately from model output and independent ground truth. The running API provides interactive documentation at /docs.

API reference

Method Endpoint Description
GET /health System health check and database connectivity status
GET /api/metrics Retrieve stored-result metrics for History or explicit run/cohort scopes
GET /api/timelines Retrieve paginated correlated threat timelines
GET /api/timelines/{timeline_id} Retrieve timeline, AI verdict and its analyst review
POST /api/timelines/{timeline_id}/analyst-review Confirm or override the current verdict once, with an override rationale
GET /api/alerts List alerts with capped pagination, filters and sorting
GET /api/alerts/{alert_id} Retrieve normalized security alert by ID
GET /api/enrichments/{indicator} Retrieve cached threat intelligence lookups for an indicator
GET /api/threat-intelligence Retrieve recorded provider statuses and compact summaries by indicator query parameter
POST /api/hunt Execute a parameterized KQL-style hunting filter across telemetry
GET /api/hunt/saved List saved hunting query definitions
PUT /api/hunt/saved Validate and save a named hunting query
POST /api/hunt/saved/delete Delete a named hunting query
GET /api/detections/rules List curated Sigma rules and load issues
GET /api/detections List recorded rule hits with capped pagination
GET /api/detections/coverage ATT&CK annotations on persisted Sigma and YARA hits
GET /api/yara/scans List recorded YARA snapshot results with capped pagination
POST /api/yara/scans Scan a registered directory offline with bounded inputs
GET /api/yara/jobs/{job_id} Retrieve a YARA job and its recorded state
GET /api/yara/scans/{scan_id} Retrieve a YARA snapshot result and linked detections
POST /api/yara/scans/{scan_id}/enrichment Explicitly look up a stored snapshot hash

Wiki home · Project README

Clone this wiki locally