list_alarms
list_alarms
Section titled “list_alarms”List controller alarms, active or archived.
Side effects: None (read-only).
Returns the most recent limit alarm records.
Not available on every firmware: UniFi Network 10.5 and 10.6 answer
400 api.err.InvalidObject on every alarm route, so on those
controllers this tool returns an error saying the feature is
unsupported rather than an empty list. It works on 10.4 and older.
Example
Section titled “Example”list_alarms(limit=20, archived=False)Parameters
Section titled “Parameters”| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit |
integer |
no | 50 | Max number of alarms to return (default 50, max 1000). |
archived |
boolean |
no | false | True lists dismissed/archived alarms; False (default) lists active alarms only. |
controller |
string |
no | “default” | Name of the UniFi controller to target. Defaults to "default". |