Skip to content

API Reference

All endpoints (except /api/login and stager delivery) require a valid JWT in the Authorization: Bearer <token> header.

POST /api/login
Content-Type: application/json
{ "username": "admin", "password": "yourpassword" }

Returns { "token": "..." }.

MethodEndpointDescription
GET/api/sessionsList all sessions
GET/api/sessions/{id}Get session detail
DELETE/api/sessions/{id}Delete session
PATCH/api/sessions/{id}Update tags, notes, detection status
MethodEndpointDescription
POST/api/sessions/{id}/taskSend a task
GET/api/sessions/{id}/tasksList task history
MethodEndpointDescription
POST/api/sessions/{id}/uploadStage a file for upload
GET/api/sessions/{id}/download/{filename}Download exfiltrated file
MethodEndpointDescription
POST/api/stagerCreate a stager token
GET/api/stagerList active tokens
DELETE/api/stager/{token}Revoke a token
MethodEndpointDescription
POST/api/reportGenerate report

Body: { "session_ids": [...], "format": "md|html|pdf", "start": "ISO date", "end": "ISO date" }

MethodEndpointDescription
GET/api/topologyGet full network topology graph

Real-time updates are pushed over WebSocket at /ws. Events include:

  • agent_checkin — new beacon checked in
  • task_result — task output available
  • pty_output — PTY data chunk
  • tunnel_status — SOCKS5 tunnel state change
  • chat_message — operator chat message