Skip to content

Runtime endpoints

The local ODevice runtime exposes an HTTP and WebSocket surface for the generated clients. Endpoints are implementation details of the self-hosted runtime; use the Python SDK for normal application development.

Common paths

PathPurpose
GET /manifestCurrent application schema and device model
GET /stateCurrent runtime state snapshot
POST /auth/loginAuthenticate a runtime user
PUT /config/pagePersist a per-user page layout overlay
DELETE /config/page/:idReset a page layout to its developer default
WebSocket runtime connectionRealtime state and command traffic

Page layout overlays

The backend developer schema is never mutated when a user edits a dashboard. The runtime stores a separate per-user overlay and resolves it against the current developer-defined page.

See Pages & sections for the stable-ID and overlay model.

Treat endpoints as versioned runtime behavior

Do not hard-code browser clients against internal runtime paths unless you own the deployment and validation process. The Python SDK and generated client remain the supported integration boundary.

Built for self-hosted IoT runtimes.