Integration

API Endpoint Reference

Complete per-endpoint API pages for the OpenHaldex controller firmware, with parse and error behavior details for robust AWD integrations.

Coverage

Total endpoints documented: 29
Every endpoint has a dedicated page with access, use, parse, and error notes.
Use with API + UI Contract for frontend behavior rules.

Core Control

`GET /api/status`

GETCore Control

Canonical runtime snapshot for UI reconciliation.

`POST /api/mode`

POSTCore Control

Set runtime mode with alias parsing and capture safety guard.

`POST /api/settings`

POSTCore Control

Main mutator for controller, mappings, generation, logging, thresholds.

Map and Curves

`GET /api/map`

GETMap and Curves

Returns active in-memory map bins and lock table.

`POST /api/map`

POSTMap and Curves

Replaces active map bins and lock table.

`GET /api/curve/speed`

GETMap and Curves

Returns current curve points for mode endpoint.

`POST /api/curve/speed`

POSTMap and Curves

Stores SPEED curve points.

`GET /api/curve/throttle`

GETMap and Curves

Returns current curve points for mode endpoint.

`POST /api/curve/throttle`

POSTMap and Curves

Stores THROTTLE curve points.

`GET /api/curve/rpm`

GETMap and Curves

Returns current curve points for mode endpoint.

`POST /api/curve/rpm`

POSTMap and Curves

Stores RPM curve points.

`GET /api/maps`

GETMap and Curves

Lists current map and available map files.

`POST /api/maps/load`

POSTMap and Curves

Loads selected map file into active map.

`POST /api/maps/save`

POSTMap and Curves

Saves active map under /maps with sanitized name.

`POST /api/maps/delete`

POSTMap and Curves

Deletes map file if allowed by backend checks.

Network and OTA

`GET /api/wifi`

GETNetwork and OTA

Returns STA SSID, STA enable, AP password set flag.

`POST /api/wifi`

POSTNetwork and OTA

Updates STA creds/enable and AP password.

`GET /api/network`

GETNetwork and OTA

Returns live AP/STA connectivity and IPs.

`GET /api/update`

GETNetwork and OTA

Returns OTA check/install status and progress fields.

`POST /api/update/check`

POSTNetwork and OTA

Triggers check and returns same schema as /api/update.

`POST /api/update/install`

POSTNetwork and OTA

Starts OTA install workflow.

Diagnostics and Logs

`GET /api/canview`

GETDiagnostics and Logs

Returns decoded/raw CAN rows with optional limits and bus filter.

`GET /api/canview/dump`

GETDiagnostics and Logs

Returns tab-delimited dump text as attachment.

`GET /api/canview/capture`

GETDiagnostics and Logs

Returns capture mode state and related control flags.

`POST /api/canview/capture`

POSTDiagnostics and Logs

Enable safe capture state or restore previous state.

`GET /api/logs`

GETDiagnostics and Logs

Lists log files across all/can/error scopes.

`GET /api/logs/read`

GETDiagnostics and Logs

Reads one log file as text with optional max-byte tail.

`POST /api/logs/delete`

POSTDiagnostics and Logs

Deletes one log file by path.

`POST /api/logs/clear`

POSTDiagnostics and Logs

Clears selected log scope.

Project Backlinks

Try the OpenHaldex Firmware Demo

Preview the real OpenHaldex firmware UI in your browser with simulated live CAN traffic and interactive pages for tuning, diagnostics, logs, setup, and OTA workflows.

Open firmware demo