Backup & updates

Check for an update

GET/api/update

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

How this copy was installed, how far behind it is and whether it can update itself (fetches from GitHub for git installs).

Responses

200OKapplication/json

methodstringrequired

One of "git" "docker" "npm" "binary" "manual" "demo"

currentstring

behindinteger

aheadinteger

changesany[]

dirtyboolean

canUpdatebooleanrequired

messagestring

403Locked, or not allowed.application/json

errorstringrequired

What went wrong, in a sentence for people.

Request

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

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

import requests

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

Response

{
  "method": "docker",
  "canUpdate": false,
  "message": "Running in Docker: update with  docker compose pull && docker compose up -d  (or rebuild the image)."
}

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