List sirens
protect_list_sirensList all sirens managed by UniFi Protect with status, volume, LED, and connection details. Use limit and offset to page results on large sites.
Instructions
List all sirens managed by UniFi Protect. Returns array; each siren includes: id, modelKey, name, mac, state, type, guid, volume, ledSettings (isEnabled), sirenStatus (isActive, activatedAt, duration), connectionType, wirelessConnectionState (signalState: signalQuality, signalStrength; batteryStatus: percentage, isLow; bridge) (7.3.70 docs). On a large site, use limit and offset to page; a paged result also returns totalCount and offset.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Return at most this many items | |
| offset | No | Skip this many items first (default 0) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | Paged results only: the index of the first item returned | |
| result | Yes | Array of items returned by the list endpoint | |
| totalCount | No | Paged results only: the number of items in the whole list |