Devices
See Pairing devices for the flow.
| Endpoint | What it does |
|---|---|
GET /workers |
List devices, paginated with limit and cursor. Names and tags are sealed, so search and filter in your client. |
GET /workers/:id |
One device. |
PATCH /workers/:id |
Replace the sealed profile (name, tags, notes), or set status to disabled, which revokes the device credential. |
DELETE /workers/:id |
Remove the device and its credential. Its addresses stay on the account, unassigned. |
POST /workers/pairing-session |
Called by the device, without a token. Takes a platform and a deviceName. Returns the session’s token and 8-digit code. |
GET /workers/pairing-session/:token |
Called by the device to poll the session. Returns the device credential once, on the first poll after the claim. |
DELETE /workers/pairing-session/:token |
Called by the device to cancel a session nobody has claimed. |
POST /workers/pair/lookup |
Find a waiting session by its 8-digit code. |
POST /workers/pair |
Claim the device. Takes the sessionId, a client-generated workerId (wkr_…) and the sealed profile. |
POST /workers/:id/keys |
Hand a paired device its sealed address keys. |
POST /workers/heartbeat |
Report that the device is active. Device credential only. |
A device returns id, operatorId, platform, status (offline or disabled), createdAt, lastActiveAt (to the hour), pausedAt and the sealed profile.