Get alarm hub
protect_get_alarm_hubRetrieve full details for a specific UniFi Protect alarm hub by ID, including armed state, battery, power, terminal status, and Thread network info.
Instructions
Get full details for a specific alarm hub by ID. Returns: 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).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Alarm hub ID |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Device ID | |
| mac | No | MAC address | |
| guid | No | Hardware MODEL GUID, shared by every unit of the same model. NOT a per-device identifier — use `id` to identify a device. | |
| name | No | Device name | |
| type | No | Hardware model name, e.g. "UVC G6 Turret", "UP Chime PoE", "UNVR-PRO" | |
| state | No | CONNECTED | DISCONNECTED | ... | |
| alarmHub | No | Alarm hub status (object: armed, battery, buckboost, connector, cover, deviceTamperStatus (e.g. "tampered", added in 7.3.x), currentMeterChannelStatus, currentMeterStatus, inputPower, poeout, powerMeter, output and input (maps keyed by channel), inputTerminalStatus, outputTerminalStatus, emergencyTerminalStatus, auxiliaryPowerTerminalStatus) | |
| modelKey | No | Resource kind | |
| lastEvent | No | Last event timestamp in epoch ms (number) | |
| isAlarmHub | No | Whether this device is an alarm hub (boolean) | |
| ledSettings | No | LED settings (object: isEnabled) | |
| threadState | No | Thread radio state, added in 7.3.x (object: network — status, role, networkName, channel, panId, extendedPanId, joinedDeviceCount, errorReason, lastUpdatedAt) |