List link stations
protect_list_link_stationsList all UniFi Protect link stations (non-alarm-hub gateways) with state, model, and settings. Page large sites using limit and offset.
Instructions
List all link stations managed by UniFi Protect. Link stations are non-alarm-hub gateways (use protect_list_alarm_hubs for alarm hubs). Returns array; each link station includes: id, modelKey ("linkstation"), name, mac, state, type, guid, isAlarmHub, ledSettings (isEnabled), lastEvent, alarmHub (armed, battery, buckboost, connector, cover, deviceTamperStatus (e.g. "tampered"), currentMeterChannelStatus, currentMeterStatus, inputPower, poeout, powerMeter, output and input (maps keyed by channel), inputTerminalStatus, outputTerminalStatus, emergencyTerminalStatus, auxiliaryPowerTerminalStatus), threadState (network: status, role, networkName, channel, panId, extendedPanId, joinedDeviceCount, errorReason, lastUpdatedAt) (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 |