HTTP API
All endpoints are read-only except scan creation, cancellation and snapshot GC.
When MISH_AUTH_TOKEN is set, send Authorization: Bearer <token> on every endpoint except
/api/v1/health. Unsafe requests require Content-Type: application/json, a same-origin
Origin/Sec-Fetch-Site, and a valid Host. DELETE /api/v1/scans/:id and POST /api/v1/gc
delete application snapshots; protect the API accordingly. Docker endpoints return 404 when
MISH_DOCKER=false.
GET /api/v1/healthGET /api/v1/versionGET /api/v1/configGET /api/v1/host/mountsGET /api/v1/host/drivesGET /api/v1/scansPOST /api/v1/scans # { roots: string[], options?: {...} }GET /api/v1/scans/:idDELETE /api/v1/scans/:idPOST /api/v1/scans/:id/cancelGET /api/v1/scans/:id/progress # JSON, or SSE with Accept: text/event-streamTree and queries
Section titled “Tree and queries”GET /api/v1/scans/:id/children/:nodeId?sort=size&limit=&offset=GET /api/v1/scans/:id/tiles?scope=&depth=&color=ext|sizeGET /api/v1/scans/:id/tree?scope=&depth=&limit=GET /api/v1/scans/:id/top?n=&kind=&metric=GET /api/v1/scans/:id/extensionsGET /api/v1/scans/:id/histogram?dim=ext|age|owner|size&scope=GET /api/v1/scans/:id/ownersGET /api/v1/scans/:id/ageGET /api/v1/scans/:id/search?q=&ext=&kind=&size_min=&size_max=&limit=GET /api/v1/scans/:id/duplicates?mode=name+size|name+size+mtime&limit=GET /api/v1/scans/:id/diff/:otherIdGET /api/v1/scans/:id/export?format=csv|json&scope=Docker (read-only)
Section titled “Docker (read-only)”GET /api/v1/docker/statusGET /api/v1/docker/containersGET /api/v1/docker/mountsGET /api/v1/docker/statsMaintenance
Section titled “Maintenance”POST /api/v1/gc # { keep: number } — delete completed snapshots beyond the newest NThe wire types are camelCase and mirror packages/api-types.