UBubiquiti
Siren information & management

Get all sirens

Get detailed information about all sirens

get/v1/sirens

Request

Response

Success response

idstring required

The primary key of siren

modelKey'siren' required

The model key of the siren

state'CONNECTED' | 'CONNECTING' | 'DISCONNECTED' required

Connection state of the device.

namestring required

The name of the device.

macstring required

The primary MAC address of the device.

volumeinteger required

Volume: a number from 1-100.

connectionType'ucp4' | 'lora' required

The connection type of the siren.

Example response

[
  {
    "id": "66d025b301ebc903e80003ea",
    "state": "CONNECTED",
    "name": "Front Door",
    "mac": "24A43C3DFEB9",
    "volume": 80,
    "ledSettings": {
      "isEnabled": true
    },
    "sirenStatus": {
      "isActive": true,
      "activatedAt": 1445408038748
    },
    "connectionType": "lora",
    "wirelessConnectionState": {
      "signalState": {
        "signalQuality": 85,
        "signalStrength": -45
      },
      "batteryStatus": {
        "percentage": 95
      },
      "bridge": "66d025b301ebc903e80003ea"
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.