Skip to main content
POST
/
api
/
driver
/
machines
/
register
Register Machine
curl --request POST \
  --url https://api.getgranite.ai/api/driver/machines/register \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_machine_id": "<string>",
  "machine_name": "<string>",
  "hostname": "<string>",
  "os_platform": "<string>",
  "os_version": "<string>",
  "arch": "<string>",
  "app_version": "<string>",
  "driver_version": "<string>",
  "tauri_version": "<string>",
  "executor_active": true,
  "metadata": {}
}
'
{
  "machine": {
    "driver_machine_id": "<string>",
    "client_machine_id": "<string>",
    "vm_api_key_id": "<string>",
    "key_label": "<string>",
    "last_seen_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "is_active": true,
    "machine_name": "<string>",
    "hostname": "<string>",
    "os_platform": "<string>",
    "os_version": "<string>",
    "arch": "<string>",
    "app_version": "<string>",
    "driver_version": "<string>",
    "tauri_version": "<string>"
  }
}

Headers

Authorization
string | null

Body

application/json

Payload emitted by the driver when registering or heartbeating.

client_machine_id
string
required

Stable identifier stored on the VM

machine_name
string | null

Friendly machine label

hostname
string | null

Machine hostname

os_platform
string | null

Operating system platform

os_version
string | null

Operating system version

arch
string | null

CPU architecture

app_version
string | null

Driver UI version

driver_version
string | null

Executor version

tauri_version
string | null

Tauri runtime version

executor_active
boolean | null
default:true

Whether the executor is currently accepting commands

metadata
Metadata · object

Additional metadata about the machine

Response

Successful Response

Response returned after registering or updating a machine.

machine
DriverMachineResponse · object
required

Stored machine metadata