Skip to content

api.md

Latest commit

 

History

History
31 lines (23 loc) · 1.01 KB

api.md

File metadata and controls

31 lines (23 loc) · 1.01 KB
Raw

API Reference

All JSON endpoints are served under /api/.

Endpoints

Method Path Purpose
GET /api/sensors/ List sensors
GET /api/readings/recent/?limit=50 Return recent readings
GET /api/sensors/<id>/readings/?limit=100 Return readings for one sensor
GET /api/alerts/active/ Return active alerts
GET /api/summary/ Return operational summary
GET /api/health/sources/ Return telemetry source status

Examples

curl -s http://127.0.0.1:8000/api/summary/
curl -s http://127.0.0.1:8000/api/health/sources/

Notes

  • Reading payloads include source, a short lineage field such as simulator:seed=42, modbus:host:port, or opcua:opc.tcp://host:port.

  • Legacy bare API routes without /api/ are not part of the public contract.

  • The source health endpoint reports simulator, Modbus, and OPC-UA. It is operational metadata: it returns each adapter's last known state and does not open a live connection per request.