REST API Documentation¶
The ecoControl server communicates through a REST-API only.
List of All API End Points¶
| API End Point | Description |
|---|---|
| General | |
| api/ | Starting point |
| api/export/ | CSV-Export function |
| api/login/ | Login end point |
| api/logout/ | Logout end point |
| api/notifications/ | Get notifications list |
| api/sensors/ | Get sensors list |
| api/settings/ | Get settings list |
| api/status/ | Get system status |
| Technician | |
| api/configure/ | Set configurations |
| api/data/(monthly|yearly)/ | Get sensor data |
| api/forecast/ | Get forecast |
| api/forward/ | forward |
| api/live/ | Get live data |
| api/settings/tunable/ | Get tunable settings |
| api/snippets/ | Manage snippets |
| api/code/ | Manage code |
| api/start/ | Start system |
| api/statistics/(monthly/) | Get statistics |
| api/thresholds/ | Manage thresholds |
| api/automoptimize/ | Manage auto optimization |
| Manager | |
| api/avgs/ | Get sensor averages |
| api/balance/total/(latest/) | Get balances |
| api/history/ | Get history |
| api/loads/ | Get loads |
| api/sensor/ | Get sensor details |
| api/sums/ | Get sensor sums |
General¶
Bla
CSV-Export function¶
/api/export
POST¶
Reflects post data and starts a CSV file download.
| Param | Description |
|---|---|
| name | Name of the service |
| description | Description of service |
POST /api/export
curl