Dashboard
NETWORK CONTROL OVERVIEW
Groups
—
Paused
—
Active Poisons
—
Unknown MACs
—
Loading...
Unknown Devices
DEVICES NOT IN ANY GROUP
Detected Unknown MACs
| Label / MAC | IP Address | Status | Assign to Group | |
|---|---|---|---|---|
| No unknown devices | ||||
All Devices
DEVICE REGISTRY — EVERY MAC EVER SEEN
Device History
| Label | MAC Address | Vendor | Last IP | Last Seen | Group | Status | Agent | |
|---|---|---|---|---|---|---|---|---|
| Loading... | ||||||||
System Logs
LAST 100 LINES
Loading...
Groups
MANAGE MAC GROUPS & TIME BUDGETS
Schedules
AUTO-PAUSE GROUPS ON A SCHEDULE
Loading...
Home Assistant
INTEGRATION CONFIGURATION
ℹ Add this configuration to your HA configuration.yaml.
REST Commands & Sensors (configuration.yaml)
Loading...
API Reference
GET /api/status — Full system status with time budgets
GET /api/devices — All devices ever seen
PATCH /api/devices/{mac} — Set device label {"label":"Kids iPhone"}
DELETE /api/devices/{mac} — Remove from registry
POST /api/groups/{id}/pause — Pause group
POST /api/groups/{id}/resume — Resume group
POST /api/groups/{id}/toggle — Toggle pause state
POST /api/groups/{id}/reward — Add reward time {"minutes": 30}
PATCH /api/groups/{id} — Update budget {"budget_minutes": 120}
POST /api/groups/{id}/macs — Add MAC {"mac":"aa:bb:...","label":"iPhone"}
DEL /api/groups/{id}/macs/{mac} — Remove MAC
POST /api/unknown/{mac}/approve — Approve unknown ?group_id=kids
POST /api/unknown-action — Set unknown policy {"action":"block"|"allow"}
All mutating endpoints require: X-Api-Key: YOUR_SECRET
Settings
SYSTEM CONFIGURATION
System Info
API Key
The API secret key used to authenticate management actions. Must match the API_SECRET value in your .env file.
Unknown Device Policy
When a new MAC is detected that doesn't belong to any group, NetGuard can automatically block it via ARP poisoning.