Skip to main content
POST
/
v1
/
edge
/
pair
Pair a home edge (idempotent): provisions MQTT creds, marks paired
curl --request POST \
  --url http://0.0.0.0:3000/v1/edge/pair \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "capabilities": {}
}
'
{
  "edge": {
    "id": 123,
    "name": "<string>",
    "org_id": "<string>",
    "status": "<string>",
    "capabilities": {}
  },
  "mqtt": {
    "username": "<string>",
    "password": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
capabilities
object

Optional capabilities to merge (lan_subnets, usb_devices, ...).

Response

Paired

edge
object
mqtt
object