UBubiquiti
Relay information & management

Get all relays

Get detailed information about all relays

get/v1/relays

Request

Response

Success response

idstring required

The primary key of relay

modelKey'relay' required

The model key of the relay

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.

Example response

[
  {
    "id": "66d025b301ebc903e80003ea",
    "state": "CONNECTED",
    "name": "Front Door",
    "mac": "24A43C3DFEB9",
    "ledSettings": {
      "isEnabled": true
    },
    "outputs": [
      {
        "name": "Garage Door",
        "type": "garageDoor",
        "pulseDuration": 1000,
        "state": "off",
        "rebootState": "off"
      }
    ],
    "inputs": [
      {
        "name": "Door Sensor",
        "state": "off",
        "actionTrigger": "switchedOn",
        "actionType": "toggleOutput"
      }
    ],
    "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.