Workspace
| Tool | What it does |
|---|---|
ListWorkspaces | Lists the workspaces available to you. |
GetBitcoinMetrics | Returns the current Bitcoin price, hashprice, network hashrate, and difficulty. |
QueryBitcoinMetrics | Returns historical Bitcoin mining market metrics as a time series. |
Farm
| Tool | What it does |
|---|---|
ListFarms | Lists the farms in a workspace. |
GetFarm | Gets a single farm by ID. |
ListAgents | Lists the Agents in a farm. |
GetAgent | Gets a single Agent by ID. |
QueryFarmMetrics | Returns time-bucketed aggregate metrics for a farm. |
QueryFarmMinerMetrics | Returns current miner classification counts and the mining mode and model distributions for a farm. |
QueryFarmHashrateComparisonMetrics | Compares pool hashrate over a 7-day or 28-day window against the previous window. |
QueryFarmMonitorEventMetrics | Returns aggregate counts of monitor events in a farm. |
ListFarmRebootEvents | Lists the reboot events detected in a farm. |
ListRacks | Deprecated. Lists the racks in a farm with their miner counts. Use ListRackGroups instead. |
Rack group
Rack group tools are in beta. See Rack groups, templates and layouts for the model.| Tool | What it does |
|---|---|
ListRackGroups | Lists all rack groups of a farm with their subnets, template, and miner summary. |
ListRackGroupTemplates | Lists the system templates and farm templates available to a farm. |
GetFarmLayout | Gets the rows, positions, stacking, and aisles of a farm. |
Change rack groups, templates, and layouts
The tools below change farm configuration; they do not send commands to miners. Review the planned changes before execution. Replacing subnets with
UpdateRackGroups merges and deletes the rack groups that fall within the new subnets.| Tool | What it does |
|---|---|
UpdateRackGroups | Names rack groups, sets their template and start offset, or replaces their subnets. |
CreateRackGroupTemplate | Creates a farm template. |
UpdateRackGroupTemplate | Changes a farm template. Rack groups that use it follow the change. |
DeleteRackGroupTemplate | Deletes a farm template. Rack groups that use it are left without a template. |
UpdateFarmLayout | Replaces the layout of a farm. |
Miner
| Tool | What it does |
|---|---|
ListMiners | Lists the miners in a farm. |
GetMiner | Gets a single miner by ID. |
ListMinerTasks | Lists the task execution history of a miner. |
ListMinerRebootTasks | Lists the reboot task history of a miner. |
QueryMinerMetrics | Returns time-bucketed performance metrics for a miner. |
ListMinerRebootEvents | Lists the reboot events detected for a miner. |
Automation
| Tool | What it does |
|---|---|
ListAutomations | Lists the automations configured in a farm. |
ListAutomationTasks | Lists the succeeded tasks that an automation dispatched, with the linked reboot recovery when available. |
QueryAutomationMetrics | Returns time-bucketed execution counts for an automation. |
Search
| Tool | What it does |
|---|---|
SearchMiners | Searches the miners in a farm with structured filters. |
SearchTaskBatches | Searches the task batches in a farm with structured filters. |
SearchFarmMonitorEvents | Searches the monitor events in a farm with structured filters. |
Task
| Tool | What it does |
|---|---|
ListTaskBatches | Lists the task batches in a farm. |
GetTaskBatch | Gets a single task batch by ID. |
ListTaskBatchTasks | Lists the individual tasks in a task batch. |
ListTaskBatchRecoveries | Lists the succeeded tasks in a task batch with their linked reboot recovery. |
Create task batches
Every tool below creates a task batch and dispatches work to miners or Agents. Confirm the targets and parameters before execution.
CreateRecordDeleteTaskBatch deletes miner records and their rack positions; a deleted miner that is still online reappears after its next report.| Tool | What it does |
|---|---|
CreateRebootTaskBatch | Reboots the specified miners. |
CreateFirmwareUpdateTaskBatch | Updates firmware on the specified miners. |
CreatePoolLockTaskBatch | Locks or unlocks pool configuration on the specified miners. |
CreateMiningModeUpdateTaskBatch | Updates the mining mode on the specified miners. |
CreateLightUpdateTaskBatch | Toggles the indicator light on the specified miners. |
CreateLogGetTaskBatch | Collects diagnostic logs from the specified miners. |
CreateTagsUpdateTaskBatch | Adds or removes tags on the specified miners. |
CreateNetworkUpdateTaskBatch | Sets static IP or DHCP network configuration on the specified miners. |
CreateRecordDeleteTaskBatch | Deletes the specified miner records from the farm. |
CreateAgentScanTaskBatch | Triggers a miner discovery scan on the Agents in the farm. |
CreateAgentIpDiagnosisTaskBatch | Runs IP connectivity diagnostics on the Agents in the farm. |
CreateAgentSelfUpdateTaskBatch | Triggers a self-update on the Agents in the farm. |
CreateAgentPauseTaskBatch | Pauses miner data reporting on all Agents in the farm. Returns AGENT_OFFLINE if any Agent in the farm is offline. |
CreateAgentResumeTaskBatch | Resumes miner data reporting on all Agents in the farm. Returns AGENT_OFFLINE if any Agent in the farm is offline. |