Create device

Create device

Create a new device. If you set ifNotExists to false and the device already exists, the deviceType will be overwritten.

POSThttps://studio.edgeimpulse.com/v1/api/{projectId}/devices/create

Path parameters

projectId*integer

Project ID

Body

application/json

deviceId*string

Globally unique device identifier (e.g. MAC address)

Example: "ac:87:a3:0a:2d:1b"

deviceType*string

Device type, for example the exact model of the device. Should be the same for all similar devices

Example: "DISCO_L475VG_IOT01A"

ifNotExists*boolean

Whether to throw an error when this device already exists.

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

Request

JavaScriptCurl

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/devices/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "deviceId": "ac:87:a3:0a:2d:1b",
      "deviceType": "DISCO_L475VG_IOT01A",
      "ifNotExists": false
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}