Skip to main content
GET
List

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
integer
default:50

Max items to return (1-500)

Required range: 1 <= x <= 500
offset
integer | null
default:0

Items to skip

Required range: x >= 0
sort
string

Comma-separated sort fields, prefix with - for descending. Allowed: name, display_name, status, type, last_seen, alias, version

status
string

Comma-separated statuses, e.g. idle,busy

type
string

Comma-separated node types

pool_id
string

Comma-separated pool ids

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

"68b1f0c2a4d3e5f6a7b8c9d0"

Required string length: 1 - 200
name
string

Exact machine name, case-sensitive

Required string length: 1 - 200
tags
string

Comma-separated tags; matches nodes carrying any of them

untagged
boolean

Also match nodes carrying no tags at all

software
string

Comma-separated software ids; matches nodes with any of them installed, e.g. blender,houdini

extend
boolean

Include joined hardware, software and benchmark data

Response

Matching nodes

data
object[]
required
total
integer
required

Total matching the filter, ignoring limit/offset

limit
integer
required
offset
integer
required