Skip to main content
POST
/
api
/
driver
/
enroll
Enroll driver with enrollment token
curl --request POST \
  --url https://api.getgranite.ai/api/driver/enroll \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_machine_id": "<string>",
  "machine_name": "<string>",
  "hostname": "<string>",
  "os_platform": "<string>",
  "os_version": "<string>",
  "arch": "<string>",
  "driver_version": "<string>",
  "app_version": "<string>",
  "executor_active": true,
  "metadata": {}
}
'
{
  "vm_api_key": "<string>",
  "driver_machine_id": "<string>",
  "client_machine_id": "<string>",
  "org_id": "<string>"
}

Headers

authorization
string | null

Body

application/json

Request to enroll a new driver (exchange token for API key)

client_machine_id
string
required

Driver-generated UUID

machine_name
string | null

Friendly machine name

hostname
string | null

Machine hostname

os_platform
string | null

Operating system (Windows, Linux, Darwin)

os_version
string | null

OS version

arch
string | null

Architecture (x86_64, ARM64, etc.)

driver_version
string | null

Driver version

app_version
string | null

App version

executor_active
boolean
default:true

Whether driver is accepting jobs

metadata
Metadata · object

Additional metadata

Response

Successful Response

Response from driver enrollment

vm_api_key
string
required

Permanent API key for driver

driver_machine_id
string
required

Backend-assigned machine ID

client_machine_id
string
required

Client's UUID (echoed back)

org_id
string
required

Organization ID