Body
actions
array of AutomationAction · required
name
string, up to 100 characters · required
triggers
array of AutomationTrigger · required
allow_unlock
boolean, default false · optional
Must be true for an automation that unlocks or opens a device, or resumes a credential.
conditions
array of AutomationCondition · optional
cooldown_s
integer, 0–86400, default 0 · optional
digest
string · optional
SHA-256 of the document in canonical JSON, without revision and digest.
enabled
boolean, default true · optional
key
string · optional
From the path.
max_runs
integer, 1–10 · optional
Runs queued or under way at once; default 1, or 10 for queued and parallel.
mode
"single" | "restart" | "queued" | "parallel" · optional
revision
integer, at least 0 · optional
Held by the hub. Sent, the save goes through only if it's the one the hub holds; 0 for one that must be new.
suspended
boolean · optional
The hub switched it off after repeated loops.
template
string, up to 64 characters · optional
The template it was deployed from: <key>@<version>.
variables
object · optional
Errors
400
invalid_request
The request is malformed or a field is invalid.
403
insufficient_scope
The key lacks the scope this operation needs.
409
conflict: revision isn't the one the hub holds; the message names it.
422
automation_rejected: the hub refused it; error.problems lists why.
503
hub_offline
hub_offline: the hub is not connected. hub_unavailable: it is connected but cannot do it now, for example its radio is down or it does not know the time yet.