Skip to content

Provision Device

POST
/api/v1/provision

Provision a new device using a provisioning token.

This is the recommended way for devices to register on first boot. The device receives a unique API key that should be stored and used for all subsequent requests.

Flow:

  1. Device boots with provisioning token baked into image
  2. Device calls this endpoint with hardware identifiers
  3. Server validates token and creates device + unique API key
  4. Device stores API key and uses it for all future requests

The provisioning token can be reused for multiple devices (fleet provisioning).

Parameters

Header Parameters

X-Provisioning-Token
required
string

Responses

200

Successful Response

Response after successful device provisioning

object
api_key
required
string
api_key_prefix
required
string
device_id
required
string
device_identifier
required
string
device_name
required
string
is_new
required
boolean
message
required
string
status
string
default: ok

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string