Skip to main content
GET
/
private-api
/
v1
/
{workspace_id}
/
farms
/
{farm_id}
/
miners
/
{miner_id}
/
tasks
List Miner Tasks
curl --request GET \
  --url https://api.nonce.app/private-api/v1/{workspace_id}/farms/{farm_id}/miners/{miner_id}/tasks \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "batchId": "<string>",
      "name": "<string>",
      "status": "<string>",
      "createdAt": "<string>",
      "miner": {
        "id": "<string>",
        "status": [
          "<string>"
        ],
        "lifecycle_status": "<string>",
        "health_status": [
          "<string>"
        ],
        "mining_mode": "<string>",
        "metadata": {
          "ip": "<string>",
          "mac": "<string>",
          "serial_number": "<string>",
          "firmware": "<string>",
          "firmware_version": "<string>",
          "make": "<string>",
          "model": "<string>",
          "farm_name": "<string>",
          "farm_location": "<string>"
        },
        "hashboards": [
          {
            "status": "<string>",
            "serial_number": "<string>"
          }
        ]
      },
      "queuingAt": "<string>",
      "pendingAt": "<string>",
      "succeedAt": "<string>",
      "failedAt": "<string>",
      "timedOutAt": "<string>",
      "cancelledAt": "<string>",
      "payload": {},
      "result": {},
      "logs": [
        {
          "timestamp": "<string>",
          "level": "<string>",
          "message": "<string>"
        }
      ],
      "downloadable": {
        "file_path": "<string>",
        "file_name": "<string>",
        "file_size": 123,
        "bucket": "<string>"
      }
    }
  ],
  "pagination": {
    "total": 50,
    "limit": 10,
    "offset": 0,
    "hasNext": true,
    "hasPrevious": false
  },
  "error": null
}

Documentation Index

Fetch the complete documentation index at: https://docs.nonce.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Clerk Machine API Key for authentication

Path Parameters

​
workspace_id
string
required
​
farm_id
string
required
​
miner_id
string
required

Query Parameters

​
page
number

Page number (default: 1)

Required range: x >= 1
Example:

1

​
pageSize
number

Number of items per page (default: 10, max: 10000)

Required range: 1 <= x <= 10000
Example:

10

​
task_name
enum<string>

Miner task name

Available options:
agent.scan.create,
agent.self.update,
miner.system.reboot,
miner.log.get,
miner.light.update,
miner.power_mode.update,
miner.pool.update,
miner.pool.lock,
miner.firmware.update,
miner.asset.update,
miner.asset.delete,
miner.rack_location.update
​
status
enum<string>

Task execution status. created = enqueued but not yet picked up by an agent; queuing = accepted by the agent and waiting in its local queue; pending = actively executing on the miner; succeed = finished successfully; failed = finished with an error; timed_out = exceeded its execution deadline; cancelled = aborted before completion.

Available options:
created,
queuing,
pending,
succeed,
failed,
timed_out,
cancelled
​
from_time
string<datetime>

Start time for task history in ISO 8601 format with timezone offset. Must be within the last 7 days. Defaults to 7 days ago if not provided

Example:

"YYYY-MM-DDTHH:MM:SSZ"

​
to_time
string<datetime>

End time for task history in ISO 8601 format with timezone offset. Must be within the last 7 days. Defaults to now if not provided

Example:

"YYYY-MM-DDTHH:MM:SSZ"

Response

Successfully retrieved miner tasks

​
success
boolean
required

Indicates if the request was successful

Example:

true

​
data
Task · object[]
required

Array of items

​
pagination
object
required

Pagination metadata

​
error
null
required

Error object (null on success)

Example:

null