Skip to Content
API ReferenceCore API routes

Core API routes

Base prefix shown as /api/v1 — some builds omit /v1; check GET /api root discovery.

MethodPathPurpose
GET/api/v1/healthLiveness for monitors
GET/api/v1/configNon-secret effective config
PATCH/api/v1/configUpdate whitelisted keys
GET/api/v1/layoutCurrent dashboard layout JSON
PUT/api/v1/layoutReplace layout
GET/api/v1/modulesInstalled modules + state
POST/api/v1/modules/:id/reloadHot reload module
GET/api/v1/calendar/eventsProxied calendar window
GET/api/v1/systemCPU, RAM, temp, uptime

💡 Tip: GET /api/v1/system powers mobile diagnostics — throttle polling to ≥ 5 s to save Wi‑Fi airtime.

Example

curl -sS -H "Authorization: Bearer $M2C2_TOKEN" \ http://127.0.0.1:3000/api/v1/system | jq

Troubleshooting

403 on PATCH config
Key not in allowlist — use Settings UI or admin scope token.

Last updated on

Was this helpful?