Skip to content

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/health
GET /api/v1/version
GET /api/v1/config
GET /api/v1/host/mounts
GET /api/v1/host/drives
GET /api/v1/scans
POST /api/v1/scans # { roots: string[], options?: {...} }
GET /api/v1/scans/:id
DELETE /api/v1/scans/:id
POST /api/v1/scans/:id/cancel
GET /api/v1/scans/:id/progress # JSON, or SSE with Accept: text/event-stream
GET /api/v1/scans/:id/children/:nodeId?sort=size&limit=&offset=
GET /api/v1/scans/:id/tiles?scope=&depth=&color=ext|size
GET /api/v1/scans/:id/tree?scope=&depth=&limit=
GET /api/v1/scans/:id/top?n=&kind=&metric=
GET /api/v1/scans/:id/extensions
GET /api/v1/scans/:id/histogram?dim=ext|age|owner|size&scope=
GET /api/v1/scans/:id/owners
GET /api/v1/scans/:id/age
GET /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/:otherId
GET /api/v1/scans/:id/export?format=csv|json&scope=
GET /api/v1/docker/status
GET /api/v1/docker/containers
GET /api/v1/docker/mounts
GET /api/v1/docker/stats
POST /api/v1/gc # { keep: number } — delete completed snapshots beyond the newest N

The wire types are camelCase and mirror packages/api-types.