API Reference

m1nd exposes 138+ REST API endpoints for full programmatic access to monitoring, asset management, network discovery, terminal sessions, and administration.

Base URL

http://<HOST_IP>:8080/api

Authentication

API requests authenticate via API keys (header) or session cookies (browser). See Authentication for details.

curl -H "X-API-Key: your-key" http://localhost:8080/api/monitors

Response Format

All endpoints return JSON:

// Success
{ "status": "ok", "data": { ... } }

// Error
{ "status": "error", "message": "Description of the error" }

Endpoint Categories

Category	Endpoints	Description
Monitors	14	Uptime monitors CRUD, checks, incidents, events
Bra1n	30+	Asset inventory across 7 entity types
V1sion	25+	Network discovery, sessions, SSH enrichment
Webhooks	6	Webhook CRUD and testing
SNMP	10	SNMP walks, vendor library, templates
Terminal	10	SSH and Telnet terminal sessions
Tools	12	Ping, traceroute, curl, port check, BGP, cert check
Alerts & Reports	6	Alert history, SMTP, email subscribers
System	15+	Config, users, SSL, updates, OOB, audit log

Real-Time Streams (SSE)

m1nd uses Server-Sent Events for live data. Connect with EventSource:

const es = new EventSource('/stream')
es.onmessage = (e) => console.log(JSON.parse(e.data))

Stream	Path	Description
Main feed	GET /stream	Live test results, alerts, monitor events
V1sion scan	GET /api/v1sion/scan/:job_id/stream	Discovery scan progress
SSH enrichment	GET /api/v1sion/enrich-ssh/:job_id/stream	SSH data collection progress
SSH terminal	GET /api/ssh/terminal/:session_id/stream	Terminal output stream
Telnet terminal	GET /api/telnet/terminal/:session_id/stream	Terminal output stream
Dev logs	GET /api/dev/logs/stream	Application log stream (admin)

Rate Limiting

Authentication endpoints are rate-limited:

• Forgot password: 5/minute, 10/hour
• Login: Rate-limited with account lockout after 5 failures