Backup & updates

Download a backup

GET/api/backup

Admin. Needs an unlock token (x-tempolight-token) while a PIN lock is set; without a lock, anyone can call it.

Everything except the PIN, as one JSON file. It includes saved passwords and tokens: keep it private.

Responses

200OKapplication/json

tempolightstring

The version that made it.

savedAtstring <date-time>

An ISO date and time.

dataobjectrequired

Everything except the PIN: devices, room, scenes, schedules, settings, songs (saved passwords and tokens too).

403Locked, or not allowed.application/json

errorstringrequired

What went wrong, in a sentence for people.

Request

curl 'http://localhost:8080/api/backup'

const res = await fetch("http://localhost:8080/api/backup");
const data = await res.json();
console.log(data);

import requests

res = requests.get(
    "http://localhost:8080/api/backup",
)
print(res.json())

Response

{
  "tempolight": "0.3.0",
  "savedAt": "2026-11-04T12:00:00.000Z",
  "data": {
    "devices": [],
    "room": {
      "name": "My room",
      "shapes": [],
      "zones": []
    },
    "scenes": []
  }
}

{
  "error": "Settings are locked. Unlock with the PIN in Settings."
}