Devices

Register a device in your own tree

Called by the desktop app, which generated the keypair. Send only the public key; Salt derives the fingerprint and refuses any private key. The device's api-key is returned once and is valid only on the device and lane endpoints.

post/api/v1/devices

Request

Base URL: https://saltapp.ai
URL: https://saltapp.ai/api/v1/devices
Auth: API key in header api-key

Request body

namestring required

platform'macos' | 'windows' required

public_keystring required

app_versionstring

The Salt Device version this computer runs.

app_commitstring

The git commit of that build (7-40 hex).

machine_idstring

Opaque, stable install id of this machine. Re-registering the same machine_id under the same owner reuses the same device (same id, new key, old api-keys revoked, open sessions ended). Without it, a device of the same name and platform that has no machine_id is reused.

Response

Created, or the existing device re-registered (same id) when machine_id matches.

idstring

namestring

platform'macos' | 'windows'

usernamestring

public_fingerprintstring

owner_idstring

created_atstring date-time

socket_seen_atstring date-time nullable

app_versionstring nullable

The Salt Device version this computer runs (e.g. 0.2.2), as the device reported it. Null until it has.

app_commitstring nullable

The git commit that build was made from (7-40 lowercase hex). Null until reported.

live_sessionboolean

public_keystring

The computer's armored public key: what a person encrypts a live-view offer to, and verifies its answer against.

fingerprintstring

The same fingerprint as public_fingerprint.

can_watchboolean

Salt Device 0.4 or newer on a Mac: this computer can show its screen live.

offline_sincestring date-time nullable

GET /devices only. When the computer is not online (no live session holds it and its socket was not seen in the last 5 minutes): the time it was last seen. Null when online or never seen.

api_keystring

Returned once, on create only.

Changes

No recorded changes to this operation across all 2 revisions of this API.