Skip to main content
GET
Retrieve

Authorizations

Authorization
string
header
required

An API key from Settings, API Keys. A caller on this machine needs none.

Path Parameters

id
string
required
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

Query Parameters

extend
boolean
default:false

Join hardware, software and benchmark data

Response

The node

id
string
required
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

system_id
string
required
name
string
required
alias
string | null
required
color
string
required
pool_id
string | null
required
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

group_id
string | null
required
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

tags
string[]
required
type
enum<string>
required
Available options:
monitor,
node,
workstation,
server,
test
user_id
string | null
required
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

license
string | null
required
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

status
enum<string>
required
Available options:
offline,
loading,
reserved,
suspended,
idle,
busy,
finishing,
error
info
string
required
version
string | null
required
last_seen
integer | null
required
Example:

1785846207000

job
object | null
required
users
object[]

Everyone signed in at this machine with the desktop app open; absent until one has been

alive
number
idle_since
integer | null
Example:

1785846207000

cloud
object | null

The cloud machine this node runs on, when a connected scale set started it

ephemeral
boolean

Removed from the farm once it has been offline long enough for its work to be handed back

spawner
object | null
hardware
object
software
object[]
benchmarks
object[]
errors
object[]
user
object | null