Skip to content
openlaunch
Esc
↑↓navigate↵open⌘Jpreview

Enroll legacy board

Legacy enrollment route; code is single use and expires after 10 minutes.

POST/v1/device/enroll
Header parameters
x-openlaunch-workspacestringrequired

Workspace routing identifier for the device credential; not a secret.

matches ^[a-f0-9]{64}$
Request body
requiredapplication/json
tokenstringrequired
min length 64 · max length 64
manifestManifestrequired
Show properties
namestringrequired
min length 1 · max length 64
kindstringrequired
min length 1 · max length 64 · matches ^[a-z][a-z0-9]*(?:[.-][a-z0-9]+)*$
capabilitiesstring[]required
min items 1 · max items 16
functionsobject[]
max items 16
Show properties
Array of object
namestringrequired
min length 1 · max length 64 · matches ^[a-z][a-z0-9_]*(?:\.[a-z][a-z0-9_]*)*$
titlestringrequired
min length 1 · max length 64
descriptionstringrequired
min length 1 · max length 240
accessstringrequired
Allowed:readwrite
inputSchemaobjectrequired
Show properties
typestringrequired
propertiesobjectrequired
requiredstring[]required
max items 16
additionalPropertiesbooleanrequired
Responses
201

Successful response

dataAttachedDevicerequired
Show properties
deviceIdstring<uuid>required
tokenstringrequired

Private child device credential. Returned only at enrollment/attachment; revoking the device invalidates it.

400

Invalid request or validation failure

errorobjectrequired
Show properties
codestringrequired
messagestring
issuesobject[]
Show properties
Array of object
pathstring
messagestring
401

Missing or invalid credential

errorobjectrequired
Show properties
codestringrequired
messagestring
issuesobject[]
Show properties
Array of object
pathstring
messagestring
403

Insufficient access or grant

errorobjectrequired
Show properties
codestringrequired
messagestring
issuesobject[]
Show properties
Array of object
pathstring
messagestring
404

Resource not found

errorobjectrequired
Show properties
codestringrequired
messagestring
issuesobject[]
Show properties
Array of object
pathstring
messagestring
413

Request body exceeds the 16 KiB limit

errorobjectrequired
Show properties
codestringrequired
messagestring
issuesobject[]
Show properties
Array of object
pathstring
messagestring
429

Rate limit or workspace capacity limit

errorobjectrequired
Show properties
codestringrequired
messagestring
issuesobject[]
Show properties
Array of object
pathstring
messagestring
500

Internal error

errorobjectrequired
Show properties
codestringrequired
messagestring
issuesobject[]
Show properties
Array of object
pathstring
messagestring
503

Service or required integration is not configured

errorobjectrequired
Show properties
codestringrequired
messagestring
issuesobject[]
Show properties
Array of object
pathstring
messagestring
Try it
Server
Parameters
Bodyapplication/json
Request
curl -X POST 'https://www.openlaunch.dev/v1/device/enroll' \
  -H 'x-openlaunch-workspace: string' \
  -H 'Content-Type: application/json' \
  -d '{
  "token": "<single-use enrollment token>",
  "manifest": {
    "name": "board",
    "kind": "uno-r4-wifi",
    "capabilities": [
      "device.health"
    ]
  }
}'
Response
{
  "data": {
    "deviceId": "4de4adb9-21ee-47e3-aeb4-8cf8ed6c109a",
    "token": "string"
  }
}