machines

Register Machine

Register a new daemon machine or re-register an existing one.

Creates the machine record if it does not already exist. Returns a short-lived machine token that the daemon uses to authenticate its WebSocket connection.

post/api/v1/machines/register

Request

  • Base URL: https://docs.omnara.com (the document declares no server; this is the origin it was published from)
  • URL: https://docs.omnara.com/api/v1/machines/register
  • Auth: HTTP bearer

Request body

machine_idstring nullable

Existing machine identifier when re-registering

machine_namestring required

Friendly name unique per user

hostnamestring required

OS hostname of the machine

platformstring required

Operating system platform (e.g. linux, darwin)

architecturestring required

CPU architecture (e.g. x86_64, arm64)

daemon_versionstring required

Semantic version of the running daemon

directoriesstring[]

Absolute paths reported by the daemon

metadataobject nullable

Arbitrary key-value metadata about the machine

Response

Successful Response

machine_tokenstring required

Short-lived JWT token for machine WebSocket authentication

machine_token_expires_ininteger required

Seconds until the machine token expires

machine_ws_pathstring required

WebSocket path the daemon should connect to

Changes

No recorded changes to this operation across all 1 revision of this API.