Get device

Retrieves a single device

GET /api/{projectId}/device/{deviceId}

Try it

Get device

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/device/{deviceId} \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "error": "<string>",
  "device": {
    "id": 1,
    "deviceId": "38:f9:d3:d7:62:03",
    "created": "2019-07-21T17:32:28Z",
    "lastSeen": "2019-08-31T17:32:28Z",
    "name": "m6d.1 desk sensor",
    "deviceType": "DISCO-L475VG",
    "sensors": [
      {
        "name": "Built-in accelerometer",
        "maxSampleLengthS": 123,
        "frequencies": [
          62.5,
          100
        ]
      }
    ],
    "remote_mgmt_connected": true,
    "supportsSnapshotStreaming": true,
    "remoteMgmtMode": "disconnected",
    "remote_mgmt_host": "<string>",
    "inferenceInfo": {
      "projectId": 123,
      "projectOwner": "<string>",
      "projectName": "<string>",
      "deployedVersion": 123,
      "modelType": "classification"
    }
  }
}

Authorizations

x-api-key · string · header · required

Path Parameters

projectId · integer · required

Project ID

deviceId · string · required

Device ID

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

error · string

Optional error description (set if 'success' was false)

device · object

Show child attributes

device. id · integer · required

Example:

1

device. deviceId · string · required

Unique identifier (such as MAC address) for a device

Example:

"38:f9:d3:d7:62:03"

device. created · string<date-time> · required

Example:

"2019-07-21T17:32:28Z"

device. lastSeen · string<date-time> · required

Last message that was received from the device (ignoring keep-alive)

Example:

"2019-08-31T17:32:28Z"

device. name · string · required

Example:

"m6d.1 desk sensor"

device. deviceType · string · required

Example:

"DISCO-L475VG"

device. sensors · object[] · required

Show child attributes

device.sensors. name · string · required

Example:

"Built-in accelerometer"

device.sensors. maxSampleLengthS · integer · required

Maximum supported sample length in seconds

device.sensors. frequencies · number[] · required

Supported frequencies for this sensor in Hz.

Example:

[62.5, 100]

device. remote_mgmt_connected · boolean · required

Whether the device is connected to the remote management interface. This property is deprecated, use remoteMgmtMode instead.

device. supportsSnapshotStreaming · boolean · required

device. remoteMgmtMode · enum<string> · required

Replaces remote_mgmt_connected. Shows whether the device is connected to the remote management interface, and in which mode.

Available options: disconnected, ingestion, inference

device. remote_mgmt_host · string

The remote management host that the device is connected to

device. inferenceInfo · object

If remoteMgmtMode is set to inference this object shows information about the model that's ran on device.

Show child attributes

device.inferenceInfo. projectId · integer · required

device.inferenceInfo. projectOwner · string · required

device.inferenceInfo. projectName · string · required

device.inferenceInfo. deployedVersion · integer · required

device.inferenceInfo. modelType · enum<string>

Available options: classification, objectDetection, constrainedObjectDetection