Skip to main content

​
Find Your Brain

The Aris Brain runs on your local network. Find it using:
If your network supports mDNS (most do):
http://aris.local

​
Check Health

First, verify the Brain is running: 
curl http://aris.local/health
Response
{
  "status": "ok",
  "version": "1.0.0",
  "uptime_seconds": 86400,
  "checks": {
    "mqtt": { "status": "ok", "connected": true },
    "cloud": { "status": "ok", "connected": true }
  }
}

​
Get an API Token

Most endpoints require authentication. Create an API token in the web UI:
  1. Open http://aris.local in your browser
  2. Go to Settings → API Tokens
  3. Click Create Token and give it a name (e.g., “My Script”)
  4. Copy the token—it’s only shown once
See Authentication for more details.

​
Read Zone Temperatures

Now use your token to read zone data: 
curl http://aris.local/api/zones \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "zones": [
    {
      "zoneId": "primary_bedroom",
      "friendlyName": "Primary Bedroom",
      "tempC": 22.4,
      "rhPercent": 45,
      "mode": "auto",
      "tempHeatSetC": 21.0,
      "tempCoolSetC": 24.0,
      "activeCall": "none"
    },
    {
      "zoneId": "living_room",
      "friendlyName": "Living Room",
      "tempC": 21.8,
      "rhPercent": 42,
      "mode": "auto",
      "tempHeatSetC": 21.0,
      "tempCoolSetC": 24.0,
      "activeCall": "heat"
    }
  ],
  "metadata": {
    "count": 2,
    "mqttConnected": true
  }
}

​
Set a Temperature

Adjust the heating setpoint for a zone: 
curl -X POST http://aris.local/api/zones/living_room/command \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"tempHeatSetC": 22.0}'
Response
{
  "success": true,
  "zoneId": "living_room",
  "command": {
    "temp_heat_set_c": 22.0
  }
}
Setpoint constraints:
  • Valid range: 10-30°C (50-86°F)
  • Minimum 2.2°C (4°F) gap between heat and cool setpoints

​
Change System Mode

Switch the entire system between heating and cooling: 
curl -X POST http://aris.local/api/system/mode \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"mode": "heat"}'
Available modes:
  • heat - Heating only
  • cool - Cooling only
  • auto - Automatic switchover
  • off - System off

​
Next Steps

Authentication

Learn about API tokens

Controlling Zones

Deep dive into zone control

Monitoring

Set up monitoring and alerts

API Reference

Explore all endpoints