Nodes
List
List nodes
GET
/
nodes
List
curl --request GET \
--url http://localhost:44442/api/v1/nodes \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:44442/api/v1/nodes"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:44442/api/v1/nodes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "44442",
CURLOPT_URL => "http://localhost:44442/api/v1/nodes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:44442/api/v1/nodes"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:44442/api/v1/nodes")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:44442/api/v1/nodes")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "68b1f0c2a4d3e5f6a7b8c9d0",
"system_id": "<string>",
"name": "<string>",
"alias": "<string>",
"color": "<string>",
"pool_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"group_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"tags": [
"<string>"
],
"type": "monitor",
"user_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"license": "68b1f0c2a4d3e5f6a7b8c9d0",
"status": "offline",
"info": "<string>",
"version": "<string>",
"last_seen": 1785846207000,
"job": {
"id": "68b1f0c2a4d3e5f6a7b8c9d0",
"step_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"tasks": [
"68b1f0c2a4d3e5f6a7b8c9d0"
]
},
"users": [
{
"user_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"away": false
}
],
"alive": 123,
"idle_since": 1785846207000,
"cloud": {
"fleet_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"instance_id": "<string>"
},
"ephemeral": true,
"spawner": {
"job_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"soft_id": "<string>",
"version": "<string>",
"type": "<string>",
"status": "<string>"
},
"hardware": {
"os": {
"platform": "",
"distro": "",
"release": "",
"build": ""
},
"cpu": {
"manufacturer": "",
"brand": "",
"speed": 0,
"cores": 0,
"physical": 0,
"processors": 0,
"utilization": null,
"temperature": null
},
"gpu": [],
"ram": {
"total": 0,
"free": 0,
"used": null,
"layout": []
},
"system": {
"manufacturer": "",
"model": "",
"virtual": false
},
"drives": [],
"system_drive": {
"mount": "",
"total": 0,
"free": 0,
"used": null
},
"network": [],
"uptime": null,
"work_threads": 0
},
"software": [
{
"soft_id": "",
"name": "",
"version": "",
"display_version": "",
"type": "host",
"id": "68b1f0c2a4d3e5f6a7b8c9d0",
"paths": [
{
"name": "",
"value": "<string>"
}
],
"plugins": "<array>",
"default": true,
"meta": {}
}
],
"benchmarks": [
{
"id": "68b1f0c2a4d3e5f6a7b8c9d0",
"definition_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"type": "vray",
"name": "<string>",
"icon": "<string>",
"value": 123,
"date": 1785846207000,
"job_id": "68b1f0c2a4d3e5f6a7b8c9d0"
}
],
"errors": [
{
"id": "68b1f0c2a4d3e5f6a7b8c9d0",
"tag": "<string>",
"level": "info",
"title": "<string>",
"node_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"count": 1,
"created_at": 1785846207000,
"updated_at": 1785846207000,
"notify": "none",
"detail": "<string>",
"help": "<string>",
"captures": {},
"variant": "<string>",
"job_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"step_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"task_id": "68b1f0c2a4d3e5f6a7b8c9d0"
}
],
"user": {
"id": "<string>",
"name": "<string>",
"alias": "<string>"
}
}
],
"total": 123,
"limit": 123,
"offset": 123
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}Authorizations
An API key from Settings, API Keys. A caller on this machine needs none.
Query Parameters
Max items to return (1-500)
Required range:
1 <= x <= 500Items to skip
Required range:
x >= 0Comma-separated sort fields, prefix with - for descending. Allowed: name, display_name, status, type, last_seen, alias, version
Comma-separated statuses, e.g. idle,busy
Comma-separated node types
Comma-separated pool ids
Pattern:
^[a-fA-F0-9]{24}$Example:
"68b1f0c2a4d3e5f6a7b8c9d0"
Required string length:
1 - 200Exact machine name, case-sensitive
Required string length:
1 - 200Comma-separated tags; matches nodes carrying any of them
Also match nodes carrying no tags at all
Comma-separated software ids; matches nodes with any of them installed, e.g. blender,houdini
Include joined hardware, software and benchmark data
Was this page helpful?
⌘I
List
curl --request GET \
--url http://localhost:44442/api/v1/nodes \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:44442/api/v1/nodes"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:44442/api/v1/nodes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "44442",
CURLOPT_URL => "http://localhost:44442/api/v1/nodes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:44442/api/v1/nodes"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:44442/api/v1/nodes")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:44442/api/v1/nodes")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "68b1f0c2a4d3e5f6a7b8c9d0",
"system_id": "<string>",
"name": "<string>",
"alias": "<string>",
"color": "<string>",
"pool_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"group_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"tags": [
"<string>"
],
"type": "monitor",
"user_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"license": "68b1f0c2a4d3e5f6a7b8c9d0",
"status": "offline",
"info": "<string>",
"version": "<string>",
"last_seen": 1785846207000,
"job": {
"id": "68b1f0c2a4d3e5f6a7b8c9d0",
"step_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"tasks": [
"68b1f0c2a4d3e5f6a7b8c9d0"
]
},
"users": [
{
"user_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"away": false
}
],
"alive": 123,
"idle_since": 1785846207000,
"cloud": {
"fleet_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"instance_id": "<string>"
},
"ephemeral": true,
"spawner": {
"job_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"soft_id": "<string>",
"version": "<string>",
"type": "<string>",
"status": "<string>"
},
"hardware": {
"os": {
"platform": "",
"distro": "",
"release": "",
"build": ""
},
"cpu": {
"manufacturer": "",
"brand": "",
"speed": 0,
"cores": 0,
"physical": 0,
"processors": 0,
"utilization": null,
"temperature": null
},
"gpu": [],
"ram": {
"total": 0,
"free": 0,
"used": null,
"layout": []
},
"system": {
"manufacturer": "",
"model": "",
"virtual": false
},
"drives": [],
"system_drive": {
"mount": "",
"total": 0,
"free": 0,
"used": null
},
"network": [],
"uptime": null,
"work_threads": 0
},
"software": [
{
"soft_id": "",
"name": "",
"version": "",
"display_version": "",
"type": "host",
"id": "68b1f0c2a4d3e5f6a7b8c9d0",
"paths": [
{
"name": "",
"value": "<string>"
}
],
"plugins": "<array>",
"default": true,
"meta": {}
}
],
"benchmarks": [
{
"id": "68b1f0c2a4d3e5f6a7b8c9d0",
"definition_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"type": "vray",
"name": "<string>",
"icon": "<string>",
"value": 123,
"date": 1785846207000,
"job_id": "68b1f0c2a4d3e5f6a7b8c9d0"
}
],
"errors": [
{
"id": "68b1f0c2a4d3e5f6a7b8c9d0",
"tag": "<string>",
"level": "info",
"title": "<string>",
"node_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"count": 1,
"created_at": 1785846207000,
"updated_at": 1785846207000,
"notify": "none",
"detail": "<string>",
"help": "<string>",
"captures": {},
"variant": "<string>",
"job_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"step_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"task_id": "68b1f0c2a4d3e5f6a7b8c9d0"
}
],
"user": {
"id": "<string>",
"name": "<string>",
"alias": "<string>"
}
}
],
"total": 123,
"limit": 123,
"offset": 123
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}