DUMB API¶

DUMB includes a built-in REST API and WebSocket server to allow programmatic control of services, logging, and system state.

How to reach it¶

How the frontend API gateway works¶

Port 3005 is not only the dashboard. The dmbdb server also acts as the normal gateway to the DUMB backend, so scripts and other API clients can use the same published address as the browser UI.

flowchart LR
    C[Browser or API client]
    F[dmbdb<br/>port 3005]
    B[DUMB FastAPI backend<br/>127.0.0.1:8000]

    C -->|/api/process/processes| F
    F -->|strip /api<br/>/process/processes| B
    C -->|/ws/status| F
    F -->|path unchanged<br/>/ws/status| B

The mapping is:

The proxy changes only the route used to reach the backend. Authentication and authorization are still enforced by FastAPI; using port 3005 does not bypass JWT requirements or expose a separate API implementation.

Endpoint paths throughout this API reference are backend-native paths. When using the normal frontend URL, prefix REST paths with /api. For example:

# Standard deployment: call through the published frontend/API gateway
curl http://localhost:3005/api/health

# Direct backend: only inside the container or when port 8000 is exposed
curl http://127.0.0.1:8000/health

WebSocket paths are forwarded without adding or removing /api.

The API is enabled and configured using the dumb_config.json under the dumb.api_service section. For example:

"api_service": {
  "enabled": true,
  "process_name": "DUMB API",
  "log_level": "INFO",
  "host": "127.0.0.1",
  "port": 8000
}

Features¶

• Authentication - JWT-based user authentication and management
• Health checks - Container and service health monitoring
• Process management - Start, stop, restart services
• Real-time streaming - WebSocket endpoints for logs, status, and metrics
• Metrics history storage - SQLite history, optional PostgreSQL, migration, compression, and fallback status
• Configuration - View and update settings (in-memory and persistent)
• Environment state inspection - Service and system information
• Notifications - Configure destinations, send tests/manual messages, and inspect persistent delivery history

Common Endpoints¶

Directory Structure¶

The DUMB API is split into the following modules:

API Documentation¶

DUMB provides built-in API documentation on the backend listener through two convenient endpoints. Because the listener is loopback-only by default, use these from inside the container or deliberately expose the backend with authentication and network controls.

• FastAPI Swagger UI
  Accessible at:
  http://<host>:<port>/docs
  This interface allows for interactive testing and exploring of all available REST endpoints.

• Scalar (ReDoc-style) Docs
  Accessible at:
  http://<host>:<port>/scalar
  A clean, read-only view of the full OpenAPI schema for the DUMB API.

These are helpful for development, debugging, and integrating external systems with DUMB.

Next Steps¶

Click on any of the modules in the sidebar to explore endpoint structure, usage examples, and development guidelines for extending the DUMB API:

• Authentication
• Health Check
• Process Management
• Configuration
• Logs
• WebSocket
• WebSocket Logs
• Seerr Sync
• AI Assistant
• Notifications
• Metrics