Nodes
List hardware
Current hardware readings of every node, paged
GET
/
nodes
/
hardware
List hardware
curl --request GET \
--url http://localhost:44442/api/v1/nodes/hardware \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:44442/api/v1/nodes/hardware"
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/hardware', 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/hardware",
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/hardware"
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/hardware")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:44442/api/v1/nodes/hardware")
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": [
{
"node_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"cpu": {
"brand": "",
"cores": 0,
"utilization": null,
"temperature": null
},
"gpu": [],
"ram": {
"total": 0,
"used": null
},
"system_drive": {
"total": 0,
"used": null
},
"network": [],
"uptime": null,
"history": {
"cadence_ms": 123,
"samples": [
[
123,
123,
123,
123
]
]
}
}
],
"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 node ids to restrict the list to
Example:
"68b1f0c2a4d3e5f6a7b8c9d0"
Attach the last ten minutes of readings to each row
Was this page helpful?
⌘I
List hardware
curl --request GET \
--url http://localhost:44442/api/v1/nodes/hardware \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:44442/api/v1/nodes/hardware"
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/hardware', 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/hardware",
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/hardware"
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/hardware")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:44442/api/v1/nodes/hardware")
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": [
{
"node_id": "68b1f0c2a4d3e5f6a7b8c9d0",
"cpu": {
"brand": "",
"cores": 0,
"utilization": null,
"temperature": null
},
"gpu": [],
"ram": {
"total": 0,
"used": null
},
"system_drive": {
"total": 0,
"used": null
},
"network": [],
"uptime": null,
"history": {
"cadence_ms": 123,
"samples": [
[
123,
123,
123,
123
]
]
}
}
],
"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>"
}
]
}