Scenes & schedules

Run a schedule now

POST/api/schedules/{id}/run

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

Does what the schedule does, now.

idstringrequired

A schedule id (t…).

200OKapplication/json

oktruerequired

403Locked, or not allowed.application/json

errorstringrequired

What went wrong, in a sentence for people.

404No such id.application/json

errorstringrequired

What went wrong, in a sentence for people.

Request

curl -X POST 'http://localhost:8080/api/schedules/id/run'

const res = await fetch("http://localhost:8080/api/schedules/id/run", {
  method: "POST",
});
const data = await res.json();
console.log(data);

import requests

res = requests.post(
    "http://localhost:8080/api/schedules/id/run",
)
print(res.json())

Response

{
  "ok": true
}

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

{
  "error": "No such schedule"
}