What to automate first
Start with read-only monitoring: hashrate, wattage, chip temperature, fan speed, pool status and error counters. Avoid automated tuning changes until you have stable baselines.
API and automation
Use this guide to plan monitoring, scripting and farm data workflows around VNISH-managed Antminers without exposing credentials or changing tuning automatically too early.
| Need | Use API-style workflow when | Use VOU/UI when |
|---|---|---|
| Monitoring | You need repeated stats collection | You need quick manual checks |
| Alerts | You want custom Telegram/Slack/NOC rules | Built-in alerts are enough |
| Reporting | You need fleet-level CSV/dashboard data | You only manage a few miners |
| Automation | You need scheduled actions by tariff or temperature | You are still validating firmware stability |
Start with read-only monitoring: hashrate, wattage, chip temperature, fan speed, pool status and error counters. Avoid automated tuning changes until you have stable baselines.
Poll miners in small batches, store timestamps, keep credentials out of scripts and alert on trends rather than one noisy sample. Always leave manual recovery access.
VOU is better for human-driven discovery and update batches. API-style integrations are better for dashboards, maintenance alerts and operations reporting.
No. Never publish miner credentials or tokens in the site, scripts or public repos.
Hashrate, efficiency, board temperatures, fan behavior, pool health, reject rate and last error state.
It can in some environments, but read-only monitoring is the safer first step. Automated tuning changes should be tested on a small pilot group.
Continue through the model, install and recovery pages before flashing production miners.
The Python example below reads a saved JSON response. Replace the required field names with the schema documented for your installed build. It makes no network request and does not change miner settings.
import json
from pathlib import Path
status = json.loads(Path("status-response.json").read_text(encoding="utf-8"))
if not isinstance(status, dict):
raise ValueError("Expected a JSON object; check the documented response schema")
required_fields = [] # Fill from the documentation for your firmware build.
if not required_fields:
raise ValueError("Configure required_fields before using this check")
missing = [name for name in required_fields if name not in status]
if missing:
raise ValueError(f"Missing status fields: {missing}")
print("Required fields are present; validate units and timestamps separately")This illustrates validation logic, not a tested API contract for every VNISH version. Continue with the control-board guide and management security checklist.
Documentation reviewed September 28, 2026. This is an independent operator guide; compatibility must be checked against the installed version. Source: project documentation.
Record the miner model, control board and full firmware version before selecting an API client. This guide does not publish a universal endpoint or authentication contract: these must come from documentation for that build.