v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Bridges

Retrieves the given bridge.

get/bridges/{bridgeId}

Query parameters

includestring[]

List of properties that should be included in the response

Response

OK

idstring required

Unique bridge identifier

accountIdstring required

Account ID specified in as an ESN Type.

namestring required

User-defined name for the device.

locationIdstring nullable

ID Of the location.

createTimestampstring date-time required
notesstring
tagsstring[]

Example response

{
  "id": "1002bc5a",
  "accountId": "00001106",
  "name": "My new device",
  "locationId": "2428fda3-389f-48ce-b062-85875dd6b2e2",
  "createTimestamp": "2023-04-04T09:38:37.372Z",
  "statusV2": {
    "cloudConnectionStatus": "connected",
    "edgeReportedDeviceStatus": "operational",
    "deviceSpecificError": "generalDeviceError"
  },
  "timeZone": {
    "zone": "America/Chicago"
  },
  "notes": "Painted black to better blend with its environment.",
  "devicePosition": {
    "latitude": 52.3074013,
    "longitude": 4.9459903,
    "floor": 50
  },
  "networkInfo": {
    "globalIP": "10.143.55.140",
    "adapters": [
      {
        "macAddress": "8A:D4:AD:09:DF:91",
        "ipAddress": "10.143.55.140"
      }
    ]
  },
  "deviceInfo": {
    "serialNumber": "100000009061f5db",
    "guid": "ddfa5b34-5d04-431e-8287-110fe87edf71"
  },
  "resourceCounts": {
    "cameras": 23,
    "bridges": 2,
    "multiCameras": 1,
    "speakers": 1,
    "users": 12,
    "accounts": 5,
    "layouts": 10,
    "locations": 10,
    "deviceTags": 3,
    "sharedCameraProxies": 10
  }
}