Devices

Rename a device, change its platform, or report its app build

Owner or root: any field. The device's own api-key (its own id only): app_version and app_commit only, so the computer can report which Salt Device build it runs; name or platform from a device key is a 403. Send only the fields to change; a blank app_version or app_commit clears it. A change is announced on the devices live topic to the owner and root.

patch/api/v1/devices/{id}

Request

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

Path parameters

idstring required

Request body

namestring
platform'macos' | 'windows'
app_versionstring

The Salt Device version this computer runs. Blank clears.

app_commitstring

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

Response

OK.

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 3 revisions of this API.