Skip to content

DUMB API

Use the API to inspect configuration, control services, read logs and metrics, and run supported maintenance workflows.

Visual guide: See how the dashboard and API exchange data.

Connect through the dashboard

The dashboard server on port 3005 is also the normal API gateway.

Client request Backend-native route
http://<host>:3005/api/health /health
http://<host>:3005/api/process/processes /process/processes
http://<host>:3005/api/auth/login /auth/login
ws://<host>:3005/ws/status /ws/status

REST paths in this reference are backend-native. Add /api when calling through the frontend. WebSockets keep /ws/* without that prefix.

curl http://localhost:3005/api/health

The native backend binds to 127.0.0.1:8000 inside DUMB by default. The maintained Compose file does not publish it. From inside the container, the equivalent request is:

curl http://127.0.0.1:8000/health

The gateway forwards requests; backend authentication still applies. It does not provide an alternate API with different permissions.

Authenticate a client

Check /api/auth/status for the current mode. When authentication is enabled, obtain a DUMB access token through the configured login flow and send it as a bearer token:

curl -H "Authorization: Bearer $DUMB_ACCESS_TOKEN" \
  http://localhost:3005/api/process/processes

See Authentication API for local login, OIDC, token refresh, and user management. See WebSocket API for socket authentication.

Endpoint references

Task Reference
Inspect or control services; check capabilities Process management
Change DUMB or application configuration Configuration
Check process/listener readiness Health
Read retained log chunks Logs
Receive live status, metrics, and logs WebSockets, log stream
Read metrics history and manage its storage Metrics
Configure destinations and inspect deliveries Notifications
Configure AI providers or preview diagnostics AI Assistant
Inspect cross-instance Seerr sync Seerr Sync
Install updates or maintain the install cache Updates
Repair, snapshot, compare, or restore links Symlinks
Migrate a supported SQLite application PostgreSQL migration
Benchmark InfiniDysk-backed rclone Rclone optimizer
Review library protection incidents Media library protection
Dev Plan and complete application integration Setup
Dev Back up or restore an installation Installation backups
Dev Register archive destinations Backup storage
Dev Install or migrate native InfiniDysk 2 InfiniDysk 2

Use the running schema

The backend serves its OpenAPI schema at /openapi.json, Swagger UI at /docs, and Scalar at /scalar. These paths are available on the backend listener; they are separate from this website.

The running schema describes the exact installed API. Before offering optional actions, inspect GET /process/capabilities and require any workflow protocol/version fields. A newer dashboard or documentation channel cannot add support to an older backend.

Source

API routing lives in api/api_service.py and api/routers/. The architecture guide explains configuration and process ownership.