Bridge information & management

Get all bridges

Get detailed information about all bridges

get/v1/bridges

Request

Response

Success response

idstring required

The primary key of bridge

modelKey'bridge' required

The model key of the bridge

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.

platformstring nullable required

The bridge platform

clientsstring[] required

Array of IoT devices mac that bridge is reserving for

maxClientsnumber required

The max acceptable client number of a V2 bridge. V1 bridge does not support this feature.

Example response

[
  {
    "id": "66d025b301ebc903e80003ea",
    "state": "CONNECTED",
    "name": "Front Door",
    "mac": "24A43C3DFEB9",
    "platform": "mt7621",
    "clients": [
      "AABBCCDDEEFF",
      "112233445566"
    ],
    "maxClients": 7
  }
]

Changes

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