Create device

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

POST /api/{projectId}/devices/create

Try it

Create device

cURL

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/devices/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "deviceId": "ac:87:a3:0a:2d:1b",
  "deviceType": "DISCO_L475VG_IOT01A",
  "ifNotExists": true
}
'

200

{
  "success": true,
  "error": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

projectId · integer · required

Project ID

Body

application/json

deviceId · string · required

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

Example:

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

deviceType · string · required

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

Example:

"DISCO_L475VG_IOT01A"

ifNotExists · boolean · required

Whether to throw an error when this device already exists.

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

error · string

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