Skip to main content

API Routes Reference

Complete reference for the Web UI REST API. All routes are protected by the auth middleware (middleware.ts) which checks for a valid iron-session cookie.

Auth​

MethodPathDescription
POST/api/authLogin with API key. Body: { apiKey: string }. Sets session cookie.
DELETE/api/authLogout. Clears session cookie.
GET/api/authCheck current session validity.

Config (Per-Server)​

All config routes are scoped to a server parameter:

MethodPathDescription
GET/api/config/{server}Get full server config
PUT/api/config/{server}Replace full server config
POST/api/config/{server}/pathsAdd path rule. Body: { path, access, description? }
PATCH/api/config/{server}/paths/{ruleId}Update path rule access. Body: access level
DELETE/api/config/{server}/paths/{ruleId}Delete path rule
POST/api/config/{server}/commandsAdd command rule. Body: { pattern, access, description? }
PATCH/api/config/{server}/commands/{ruleId}Update command rule access
DELETE/api/config/{server}/commands/{ruleId}Delete command rule
POST/api/config/{server}/toolsAdd tool rule. Body: { pattern, access, description? }
PATCH/api/config/{server}/tools/{ruleId}Update tool rule access
DELETE/api/config/{server}/tools/{ruleId}Delete tool rule
PATCH/api/config/{server}/bulkBulk set all paths or commands. Body: { access, type }
PATCH/api/config/{server}/cascadeCascade path access to children. Body: { ruleId, access }

Agents​

MethodPathDescription
GET/api/agentsGet users config (mode + user list)
PUT/api/agentsUpdate users settings (mode). Body: { mode }
PATCH/api/agents/{id}Update user. Body: { enabled?, tools?, key? }

Audit​

MethodPathDescription
GET/api/audit/{server}Get audit log entries. Query: ?limit=50&offset=0

Health & Status​

MethodPathDescription
GET/api/health/{server}Get container health status
PATCH/api/servers/{server}/statusEnable/disable server. Body: { enabled: boolean }
GET/api/servers/statusGet all server statuses

Scan​

MethodPathDescription
POST/api/scan/{server}Trigger folder scan
POST/api/scan/{server}/cancelCancel running scan
GET/api/scan-statusGet current scan status. Response: { scanning, server }

Folders​

MethodPathDescription
GET/api/folders/{server}Get discovered folder tree. Response: { folders: FolderNode[], server, count }

Settings​

MethodPathDescription
GET/api/settingsGet app settings. Response: { scan, auditPageSize }
PUT/api/settingsUpdate app settings