Workspace
| Tool | Description |
|---|---|
ListWorkspaces | List the workspaces available to you. |
GetBitcoinMetrics | Current snapshot of Bitcoin price, hashprice, network hashrate, and difficulty. |
QueryBitcoinMetrics | Historical Bitcoin mining market metrics as a time series. |
Farm
| Tool | Description |
|---|---|
ListFarms | List farms in a workspace. |
GetFarm | Get a single farm by ID. |
ListAgents | List agents in a farm. |
GetAgent | Get a single agent by ID. |
QueryFarmMetrics | Time-bucketed aggregate metrics for a farm. |
QueryFarmMinerMetrics | Current miner classification counts and mining mode and model distributions for a farm. |
ListFarmRebootEvents | Detected reboot events in a farm. |
Miner
| Tool | Description |
|---|---|
ListMiners | List miners in a farm. |
GetMiner | Get a single miner by ID. |
ListMinerTasks | Task execution history for a miner. |
ListMinerRebootTasks | Reboot task history for a miner. |
QueryMinerMetrics | Time-bucketed performance metrics for a miner. |
ListMinerRebootEvents | Detected reboot events for a miner. |
Search
| Tool | Description |
|---|---|
SearchMiners | Search miners in a farm with structured filters. |
SearchTaskBatches | Search task batches in a farm with structured filters. |
Task
| Tool | Description |
|---|---|
ListTaskBatches | List task batches in a farm. |
GetTaskBatch | Get a single task batch by ID. |
ListTaskBatchTasks | List individual tasks in a task batch. |
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 cannot be undone.| Tool | Description |
|---|---|
CreateRebootTaskBatch | Reboot the specified miners. |
CreateFirmwareUpdateTaskBatch | Update firmware on the specified miners. |
CreatePoolLockTaskBatch | Lock or unlock pool configuration on the specified miners. |
CreateMiningModeUpdateTaskBatch | Update the mining mode on the specified miners. |
CreateLightUpdateTaskBatch | Toggle the indicator light on the specified miners. |
CreateLogGetTaskBatch | Collect diagnostic logs from the specified miners. |
CreateTagsUpdateTaskBatch | Add or remove tags on the specified miners. |
CreateRackUpdateTaskBatch | Update rack location metadata for the specified miners. |
CreateRecordDeleteTaskBatch | Permanently delete the specified miner records from the farm. |
CreateAgentScanTaskBatch | Trigger a miner discovery scan on agents in the farm. |
CreateAgentIpDiagnosisTaskBatch | Run IP connectivity diagnostics on agents in the farm. |
CreateAgentSelfUpdateTaskBatch | Trigger a self-update on agents in the farm. |