API and automation

VNISH API and automation guide

Use this guide to plan monitoring, scripting and farm data workflows around VNISH-managed Antminers without exposing credentials or changing tuning automatically too early.

API intentMonitoringAutomationFarm data
NeedUse API-style workflow whenUse VOU/UI when
MonitoringYou need repeated stats collectionYou need quick manual checks
AlertsYou want custom Telegram/Slack/NOC rulesBuilt-in alerts are enough
ReportingYou need fleet-level CSV/dashboard dataYou only manage a few miners
AutomationYou need scheduled actions by tariff or temperatureYou are still validating firmware stability

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.

Safe integration pattern

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.

API vs VOU

VOU is better for human-driven discovery and update batches. API-style integrations are better for dashboards, maintenance alerts and operations reporting.

Frequently asked questions

Does this page publish private API credentials?+

No. Never publish miner credentials or tokens in the site, scripts or public repos.

What should an API dashboard show first?+

Hashrate, efficiency, board temperatures, fan behavior, pool health, reject rate and last error state.

Can automation change tuning automatically?+

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.

Related VNISH guides

Continue through the model, install and recovery pages before flashing production miners.