Search Miners
curl --request POST \
--url https://api.nonce.app/private-api/v1/{workspace_id}/farms/{farm_id}/miners/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": {
"in": [
"miner_abc123",
"miner_def456"
]
},
"agent_id": {
"eq": "123e4567-e89b-12d3-a456-426614174000"
},
"sn": {
"eq": "HTM3FS28HD25011939878367054H36045"
},
"mac": {
"eq": "00:1A:2B:3C:4D:5E"
},
"status": {
"in": [
"online",
"stale"
]
},
"tags": {
"in": [
"maintenance",
"building-a"
]
},
"unstable": true,
"lifecycle_statuses": {
"in": [
"online",
"offline"
]
},
"health_statuses": {
"in": [
"online",
"offline"
]
},
"network_mode": {
"in": [
"dhcp",
"unknown"
]
},
"ip_ranges": [
"192.168.1.5",
"192.168.144.0/24",
"10.0.0.1-10.0.0.50"
],
"page": 1,
"limit": 50
}
'import requests
url = "https://api.nonce.app/private-api/v1/{workspace_id}/farms/{farm_id}/miners/search"
payload = {
"id": { "in": ["miner_abc123", "miner_def456"] },
"agent_id": { "eq": "123e4567-e89b-12d3-a456-426614174000" },
"sn": { "eq": "HTM3FS28HD25011939878367054H36045" },
"mac": { "eq": "00:1A:2B:3C:4D:5E" },
"status": { "in": ["online", "stale"] },
"tags": { "in": ["maintenance", "building-a"] },
"unstable": True,
"lifecycle_statuses": { "in": ["online", "offline"] },
"health_statuses": { "in": ["online", "offline"] },
"network_mode": { "in": ["dhcp", "unknown"] },
"ip_ranges": ["192.168.1.5", "192.168.144.0/24", "10.0.0.1-10.0.0.50"],
"page": 1,
"limit": 50
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: {in: ['miner_abc123', 'miner_def456']},
agent_id: {eq: '123e4567-e89b-12d3-a456-426614174000'},
sn: {eq: 'HTM3FS28HD25011939878367054H36045'},
mac: {eq: '00:1A:2B:3C:4D:5E'},
status: {in: ['online', 'stale']},
tags: {in: ['maintenance', 'building-a']},
unstable: true,
lifecycle_statuses: {in: ['online', 'offline']},
health_statuses: {in: ['online', 'offline']},
network_mode: {in: ['dhcp', 'unknown']},
ip_ranges: ['192.168.1.5', '192.168.144.0/24', '10.0.0.1-10.0.0.50'],
page: 1,
limit: 50
})
};
fetch('https://api.nonce.app/private-api/v1/{workspace_id}/farms/{farm_id}/miners/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.nonce.app/private-api/v1/{workspace_id}/farms/{farm_id}/miners/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => [
'in' => [
'miner_abc123',
'miner_def456'
]
],
'agent_id' => [
'eq' => '123e4567-e89b-12d3-a456-426614174000'
],
'sn' => [
'eq' => 'HTM3FS28HD25011939878367054H36045'
],
'mac' => [
'eq' => '00:1A:2B:3C:4D:5E'
],
'status' => [
'in' => [
'online',
'stale'
]
],
'tags' => [
'in' => [
'maintenance',
'building-a'
]
],
'unstable' => true,
'lifecycle_statuses' => [
'in' => [
'online',
'offline'
]
],
'health_statuses' => [
'in' => [
'online',
'offline'
]
],
'network_mode' => [
'in' => [
'dhcp',
'unknown'
]
],
'ip_ranges' => [
'192.168.1.5',
'192.168.144.0/24',
'10.0.0.1-10.0.0.50'
],
'page' => 1,
'limit' => 50
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.nonce.app/private-api/v1/{workspace_id}/farms/{farm_id}/miners/search"
payload := strings.NewReader("{\n \"id\": {\n \"in\": [\n \"miner_abc123\",\n \"miner_def456\"\n ]\n },\n \"agent_id\": {\n \"eq\": \"123e4567-e89b-12d3-a456-426614174000\"\n },\n \"sn\": {\n \"eq\": \"HTM3FS28HD25011939878367054H36045\"\n },\n \"mac\": {\n \"eq\": \"00:1A:2B:3C:4D:5E\"\n },\n \"status\": {\n \"in\": [\n \"online\",\n \"stale\"\n ]\n },\n \"tags\": {\n \"in\": [\n \"maintenance\",\n \"building-a\"\n ]\n },\n \"unstable\": true,\n \"lifecycle_statuses\": {\n \"in\": [\n \"online\",\n \"offline\"\n ]\n },\n \"health_statuses\": {\n \"in\": [\n \"online\",\n \"offline\"\n ]\n },\n \"network_mode\": {\n \"in\": [\n \"dhcp\",\n \"unknown\"\n ]\n },\n \"ip_ranges\": [\n \"192.168.1.5\",\n \"192.168.144.0/24\",\n \"10.0.0.1-10.0.0.50\"\n ],\n \"page\": 1,\n \"limit\": 50\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.nonce.app/private-api/v1/{workspace_id}/farms/{farm_id}/miners/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": {\n \"in\": [\n \"miner_abc123\",\n \"miner_def456\"\n ]\n },\n \"agent_id\": {\n \"eq\": \"123e4567-e89b-12d3-a456-426614174000\"\n },\n \"sn\": {\n \"eq\": \"HTM3FS28HD25011939878367054H36045\"\n },\n \"mac\": {\n \"eq\": \"00:1A:2B:3C:4D:5E\"\n },\n \"status\": {\n \"in\": [\n \"online\",\n \"stale\"\n ]\n },\n \"tags\": {\n \"in\": [\n \"maintenance\",\n \"building-a\"\n ]\n },\n \"unstable\": true,\n \"lifecycle_statuses\": {\n \"in\": [\n \"online\",\n \"offline\"\n ]\n },\n \"health_statuses\": {\n \"in\": [\n \"online\",\n \"offline\"\n ]\n },\n \"network_mode\": {\n \"in\": [\n \"dhcp\",\n \"unknown\"\n ]\n },\n \"ip_ranges\": [\n \"192.168.1.5\",\n \"192.168.144.0/24\",\n \"10.0.0.1-10.0.0.50\"\n ],\n \"page\": 1,\n \"limit\": 50\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nonce.app/private-api/v1/{workspace_id}/farms/{farm_id}/miners/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": {\n \"in\": [\n \"miner_abc123\",\n \"miner_def456\"\n ]\n },\n \"agent_id\": {\n \"eq\": \"123e4567-e89b-12d3-a456-426614174000\"\n },\n \"sn\": {\n \"eq\": \"HTM3FS28HD25011939878367054H36045\"\n },\n \"mac\": {\n \"eq\": \"00:1A:2B:3C:4D:5E\"\n },\n \"status\": {\n \"in\": [\n \"online\",\n \"stale\"\n ]\n },\n \"tags\": {\n \"in\": [\n \"maintenance\",\n \"building-a\"\n ]\n },\n \"unstable\": true,\n \"lifecycle_statuses\": {\n \"in\": [\n \"online\",\n \"offline\"\n ]\n },\n \"health_statuses\": {\n \"in\": [\n \"online\",\n \"offline\"\n ]\n },\n \"network_mode\": {\n \"in\": [\n \"dhcp\",\n \"unknown\"\n ]\n },\n \"ip_ranges\": [\n \"192.168.1.5\",\n \"192.168.144.0/24\",\n \"10.0.0.1-10.0.0.50\"\n ],\n \"page\": 1,\n \"limit\": 50\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"id": "002b1a50fa281efe0f320ebc39f5047b",
"farm_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"farm": {
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Farm Name"
},
"workspace_id": "org_xxxxxxxxxxxxxxxxxxxxxxxxxxx",
"serial_number": "HTM3FS28HD25011939878367054H36045",
"model": "Antminer S19",
"ip": "192.168.1.100",
"mac": "00:1B:44:11:3A:B7",
"firmware_version": "20250304.15.REL",
"rack": "A1",
"position": 3,
"is_mining": true,
"last_check_succeed": true,
"stale": false,
"overheat": false,
"low_hashrate": false,
"overpower": false,
"underpower": false,
"status": "online",
"ops_status": "<string>",
"lifecycle_status": "<string>",
"unstable_reason": null,
"health_status": null,
"mining_mode": "normal",
"mining_mode_preset": "<string>",
"hashrate": 100120000000000,
"expected_hashrate": 125000000000000,
"hashrate_24h": 100120000000000,
"power": 9771,
"temp": 75.5,
"temperature_inlet_avg": 35.5,
"temperature_outlet_avg": 65.5,
"efficiency": 34,
"uptime": 86400,
"last_updated_at": "2025-08-27T00:00:00Z",
"created_at": "2025-08-27T00:00:00Z",
"errors": [
{
"code": "E001",
"message": "Temperature too high"
}
],
"hashboards": [
{
"serial_number": "HB123456",
"hashrate": 25120000000000,
"chips": 4,
"chip_frequency": 650
}
],
"total_chips": 5,
"expected_chips": 4,
"reboot_count": 0,
"low_uptime_reboot_count": 0,
"network": null,
"tags": [],
"anomaly_flags": 0,
"pools": [],
"psus": []
}
],
"pagination": {
"total": 50,
"limit": 10,
"offset": 0,
"hasNext": true,
"hasPrevious": false
},
"error": null
}{
"success": false,
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation failed"
}
}{
"success": false,
"data": null,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}
}{
"success": false,
"data": null,
"error": {
"code": "FORBIDDEN",
"message": "Access denied to workspace"
}
}{
"success": false,
"data": null,
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error"
}
}Miners
Search Miners
Search miners in the farm with operator-object filters. Supports id, agent_id, sn, mac, status, tags, and ip_ranges criteria. lifecycle_statuses is the legacy combined filter; still accepted for backward compatibility (values are auto-routed to status / tags). health_statuses is deprecated and ignored at runtime. Omit body for an unfiltered first-page list.
POST
/
private-api
/
v1
/
{workspace_id}
/
farms
/
{farm_id}
/
miners
/
search
Search Miners
curl --request POST \
--url https://api.nonce.app/private-api/v1/{workspace_id}/farms/{farm_id}/miners/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": {
"in": [
"miner_abc123",
"miner_def456"
]
},
"agent_id": {
"eq": "123e4567-e89b-12d3-a456-426614174000"
},
"sn": {
"eq": "HTM3FS28HD25011939878367054H36045"
},
"mac": {
"eq": "00:1A:2B:3C:4D:5E"
},
"status": {
"in": [
"online",
"stale"
]
},
"tags": {
"in": [
"maintenance",
"building-a"
]
},
"unstable": true,
"lifecycle_statuses": {
"in": [
"online",
"offline"
]
},
"health_statuses": {
"in": [
"online",
"offline"
]
},
"network_mode": {
"in": [
"dhcp",
"unknown"
]
},
"ip_ranges": [
"192.168.1.5",
"192.168.144.0/24",
"10.0.0.1-10.0.0.50"
],
"page": 1,
"limit": 50
}
'import requests
url = "https://api.nonce.app/private-api/v1/{workspace_id}/farms/{farm_id}/miners/search"
payload = {
"id": { "in": ["miner_abc123", "miner_def456"] },
"agent_id": { "eq": "123e4567-e89b-12d3-a456-426614174000" },
"sn": { "eq": "HTM3FS28HD25011939878367054H36045" },
"mac": { "eq": "00:1A:2B:3C:4D:5E" },
"status": { "in": ["online", "stale"] },
"tags": { "in": ["maintenance", "building-a"] },
"unstable": True,
"lifecycle_statuses": { "in": ["online", "offline"] },
"health_statuses": { "in": ["online", "offline"] },
"network_mode": { "in": ["dhcp", "unknown"] },
"ip_ranges": ["192.168.1.5", "192.168.144.0/24", "10.0.0.1-10.0.0.50"],
"page": 1,
"limit": 50
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: {in: ['miner_abc123', 'miner_def456']},
agent_id: {eq: '123e4567-e89b-12d3-a456-426614174000'},
sn: {eq: 'HTM3FS28HD25011939878367054H36045'},
mac: {eq: '00:1A:2B:3C:4D:5E'},
status: {in: ['online', 'stale']},
tags: {in: ['maintenance', 'building-a']},
unstable: true,
lifecycle_statuses: {in: ['online', 'offline']},
health_statuses: {in: ['online', 'offline']},
network_mode: {in: ['dhcp', 'unknown']},
ip_ranges: ['192.168.1.5', '192.168.144.0/24', '10.0.0.1-10.0.0.50'],
page: 1,
limit: 50
})
};
fetch('https://api.nonce.app/private-api/v1/{workspace_id}/farms/{farm_id}/miners/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.nonce.app/private-api/v1/{workspace_id}/farms/{farm_id}/miners/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => [
'in' => [
'miner_abc123',
'miner_def456'
]
],
'agent_id' => [
'eq' => '123e4567-e89b-12d3-a456-426614174000'
],
'sn' => [
'eq' => 'HTM3FS28HD25011939878367054H36045'
],
'mac' => [
'eq' => '00:1A:2B:3C:4D:5E'
],
'status' => [
'in' => [
'online',
'stale'
]
],
'tags' => [
'in' => [
'maintenance',
'building-a'
]
],
'unstable' => true,
'lifecycle_statuses' => [
'in' => [
'online',
'offline'
]
],
'health_statuses' => [
'in' => [
'online',
'offline'
]
],
'network_mode' => [
'in' => [
'dhcp',
'unknown'
]
],
'ip_ranges' => [
'192.168.1.5',
'192.168.144.0/24',
'10.0.0.1-10.0.0.50'
],
'page' => 1,
'limit' => 50
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.nonce.app/private-api/v1/{workspace_id}/farms/{farm_id}/miners/search"
payload := strings.NewReader("{\n \"id\": {\n \"in\": [\n \"miner_abc123\",\n \"miner_def456\"\n ]\n },\n \"agent_id\": {\n \"eq\": \"123e4567-e89b-12d3-a456-426614174000\"\n },\n \"sn\": {\n \"eq\": \"HTM3FS28HD25011939878367054H36045\"\n },\n \"mac\": {\n \"eq\": \"00:1A:2B:3C:4D:5E\"\n },\n \"status\": {\n \"in\": [\n \"online\",\n \"stale\"\n ]\n },\n \"tags\": {\n \"in\": [\n \"maintenance\",\n \"building-a\"\n ]\n },\n \"unstable\": true,\n \"lifecycle_statuses\": {\n \"in\": [\n \"online\",\n \"offline\"\n ]\n },\n \"health_statuses\": {\n \"in\": [\n \"online\",\n \"offline\"\n ]\n },\n \"network_mode\": {\n \"in\": [\n \"dhcp\",\n \"unknown\"\n ]\n },\n \"ip_ranges\": [\n \"192.168.1.5\",\n \"192.168.144.0/24\",\n \"10.0.0.1-10.0.0.50\"\n ],\n \"page\": 1,\n \"limit\": 50\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.nonce.app/private-api/v1/{workspace_id}/farms/{farm_id}/miners/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": {\n \"in\": [\n \"miner_abc123\",\n \"miner_def456\"\n ]\n },\n \"agent_id\": {\n \"eq\": \"123e4567-e89b-12d3-a456-426614174000\"\n },\n \"sn\": {\n \"eq\": \"HTM3FS28HD25011939878367054H36045\"\n },\n \"mac\": {\n \"eq\": \"00:1A:2B:3C:4D:5E\"\n },\n \"status\": {\n \"in\": [\n \"online\",\n \"stale\"\n ]\n },\n \"tags\": {\n \"in\": [\n \"maintenance\",\n \"building-a\"\n ]\n },\n \"unstable\": true,\n \"lifecycle_statuses\": {\n \"in\": [\n \"online\",\n \"offline\"\n ]\n },\n \"health_statuses\": {\n \"in\": [\n \"online\",\n \"offline\"\n ]\n },\n \"network_mode\": {\n \"in\": [\n \"dhcp\",\n \"unknown\"\n ]\n },\n \"ip_ranges\": [\n \"192.168.1.5\",\n \"192.168.144.0/24\",\n \"10.0.0.1-10.0.0.50\"\n ],\n \"page\": 1,\n \"limit\": 50\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nonce.app/private-api/v1/{workspace_id}/farms/{farm_id}/miners/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": {\n \"in\": [\n \"miner_abc123\",\n \"miner_def456\"\n ]\n },\n \"agent_id\": {\n \"eq\": \"123e4567-e89b-12d3-a456-426614174000\"\n },\n \"sn\": {\n \"eq\": \"HTM3FS28HD25011939878367054H36045\"\n },\n \"mac\": {\n \"eq\": \"00:1A:2B:3C:4D:5E\"\n },\n \"status\": {\n \"in\": [\n \"online\",\n \"stale\"\n ]\n },\n \"tags\": {\n \"in\": [\n \"maintenance\",\n \"building-a\"\n ]\n },\n \"unstable\": true,\n \"lifecycle_statuses\": {\n \"in\": [\n \"online\",\n \"offline\"\n ]\n },\n \"health_statuses\": {\n \"in\": [\n \"online\",\n \"offline\"\n ]\n },\n \"network_mode\": {\n \"in\": [\n \"dhcp\",\n \"unknown\"\n ]\n },\n \"ip_ranges\": [\n \"192.168.1.5\",\n \"192.168.144.0/24\",\n \"10.0.0.1-10.0.0.50\"\n ],\n \"page\": 1,\n \"limit\": 50\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"id": "002b1a50fa281efe0f320ebc39f5047b",
"farm_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"farm": {
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Farm Name"
},
"workspace_id": "org_xxxxxxxxxxxxxxxxxxxxxxxxxxx",
"serial_number": "HTM3FS28HD25011939878367054H36045",
"model": "Antminer S19",
"ip": "192.168.1.100",
"mac": "00:1B:44:11:3A:B7",
"firmware_version": "20250304.15.REL",
"rack": "A1",
"position": 3,
"is_mining": true,
"last_check_succeed": true,
"stale": false,
"overheat": false,
"low_hashrate": false,
"overpower": false,
"underpower": false,
"status": "online",
"ops_status": "<string>",
"lifecycle_status": "<string>",
"unstable_reason": null,
"health_status": null,
"mining_mode": "normal",
"mining_mode_preset": "<string>",
"hashrate": 100120000000000,
"expected_hashrate": 125000000000000,
"hashrate_24h": 100120000000000,
"power": 9771,
"temp": 75.5,
"temperature_inlet_avg": 35.5,
"temperature_outlet_avg": 65.5,
"efficiency": 34,
"uptime": 86400,
"last_updated_at": "2025-08-27T00:00:00Z",
"created_at": "2025-08-27T00:00:00Z",
"errors": [
{
"code": "E001",
"message": "Temperature too high"
}
],
"hashboards": [
{
"serial_number": "HB123456",
"hashrate": 25120000000000,
"chips": 4,
"chip_frequency": 650
}
],
"total_chips": 5,
"expected_chips": 4,
"reboot_count": 0,
"low_uptime_reboot_count": 0,
"network": null,
"tags": [],
"anomaly_flags": 0,
"pools": [],
"psus": []
}
],
"pagination": {
"total": 50,
"limit": 10,
"offset": 0,
"hasNext": true,
"hasPrevious": false
},
"error": null
}{
"success": false,
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation failed"
}
}{
"success": false,
"data": null,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}
}{
"success": false,
"data": null,
"error": {
"code": "FORBIDDEN",
"message": "Access denied to workspace"
}
}{
"success": false,
"data": null,
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error"
}
}Authorizations
Clerk Machine API Key for authentication
Body
application/json
Miner ID filter. Supports exact match (eq) or set membership (in).
Show child attributes
Show child attributes
Example:
{ "in": ["miner_abc123", "miner_def456"] }
Agent ID filter. Use exact match (eq) with the agent UUID.
Show child attributes
Show child attributes
Example:
{
"eq": "123e4567-e89b-12d3-a456-426614174000"
}
Miner serial number filter. Use exact match (eq).
Show child attributes
Show child attributes
Example:
{ "eq": "HTM3FS28HD25011939878367054H36045" }
Miner MAC address filter. Use exact match (eq).
Show child attributes
Show child attributes
Example:
{ "eq": "00:1A:2B:3C:4D:5E" }
Run status filter. Accepted values: online, stale.
Show child attributes
Show child attributes
Example:
{ "in": ["online", "stale"] }
Tag filter (operator-managed labels). Overlap match. Preset values: maintenance, retired, off_rack, transit, archived, plus free-form custom tags.
Show child attributes
Show child attributes
Example:
{ "in": ["maintenance", "building-a"] }
Unstable filter. true returns only miners with non-null unstable_reason. Omit to include both stable and unstable miners.
Deprecated — legacy combined filter. Use status and tags instead. Values are auto-routed to the matching axis. Note: run-state and tags are independent — filtering by a run-state value (e.g. online) does not exclude miners carrying tags. Will be removed in a future major version.
Show child attributes
Show child attributes
Example:
{ "in": ["online", "offline"] }
Deprecated — accepted for backward compatibility but ignored at runtime. Use anomaly_filters (anomaly bitmask) or hashrate_realization (ratio range) instead.
Show child attributes
Show child attributes
Example:
{ "in": ["online", "offline"] }
Network mode filter. unknown matches miners whose firmware does not report a mode or that have not been collected yet.
Show child attributes
Show child attributes
Example:
{ "in": ["dhcp", "unknown"] }
Filter miners by IPv4 ranges. A miner matches if its IP falls into any of the provided ranges. Each item accepts one of: single address 192.168.1.5, CIDR 192.168.1.0/24, or hyphen range 192.168.1.1-192.168.1.254. At most 10 ranges per request.
Maximum array length:
10Pattern:
^(?:(?:(25[0-5]|2[0-4]\d|[01]?\d\d?)\.){3}(25[0-5]|2[0-4]\d|[01]?\d\d?)\/(?:3[0-2]|[12]?\d)|(?:(25[0-5]|2[0-4]\d|[01]?\d\d?)\.){3}(25[0-5]|2[0-4]\d|[01]?\d\d?)-(?:(25[0-5]|2[0-4]\d|[01]?\d\d?)\.){3}(25[0-5]|2[0-4]\d|[01]?\d\d?)|(?:(25[0-5]|2[0-4]\d|[01]?\d\d?)\.){3}(25[0-5]|2[0-4]\d|[01]?\d\d?))$Example:
[
"192.168.1.5",
"192.168.144.0/24",
"10.0.0.1-10.0.0.50"
]
Page number, starting at 1
Required range:
1 <= x <= 9007199254740991Example:
1
Results per page
Required range:
1 <= x <= 10000Example:
50
Response
Successfully retrieved miner status
⌘I