Create device

Create device

post

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

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

projectIdintegerrequired

Project ID

Body

deviceIdstringrequired

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

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

deviceTypestringrequired

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

Example: DISCO_L475VG_IOT01A

ifNotExistsbooleanrequired

Whether to throw an error when this device already exists.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

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

OK