Skip to content

4. Local Server API

Midian Tekle Elfu edited this page Jan 11, 2026 · 2 revisions

Once the Local Server is running, you can interact with it using standard HTTP requests.

Base URL http://localhost:10800 (or whatever port you configured).

Endpoints

1. Configure the Connection

Before sending commands, the server needs to know which device to talk to.

  • POST /configure
  • Body:
{
  "dsn": "YOUR_DEVICE_DSN",
  "device_ip": "LOCAL.DEVICE.IP.ADDRESS",
  "lan_key": "YOUR_LAN_KEY",
  "device_scheme": "http",
  "monitor_property_name": "MONITOR_PROPERTY_NAME"
}

Note: lan_key can be obtained from the Cloud API

2. Send a Command

  • POST /command
  • Body:
{
  "command": "COMMAND"
}

Note: More information on how to generate a valid command

3. Get device Status (Monitor)

Returns the decoded status of the machine.

  • GET /get_monitor
  • Response:
{
  "monitor": { ... },
  "monitor_b64": "...",
  "received_at": 1678886400.0
}

4. Refresh Status

Forces a refresh of the monitor status from the device.

  • GET /refresh_monitor

5. Get Raw Properties

  • GET /get_properties

Clone this wiki locally