Get siren
protect_get_sirenRetrieve full details for a UniFi Protect siren by ID, including state, volume, LED settings, siren status, and wireless connection diagnostics.
Instructions
Get full details for a specific siren by ID. Returns: 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).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Siren 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 | ... | |
| volume | No | Siren volume (number) | |
| modelKey | No | Resource kind | |
| ledSettings | No | LED settings (object: isEnabled) | |
| sirenStatus | No | Current siren status (object: isActive, activatedAt, duration) | |
| connectionType | No | Connection type, e.g. "lora" | |
| wirelessConnectionState | No | Wireless link state (object: signalState { signalQuality, signalStrength }, batteryStatus { percentage, isLow }, bridge) |