Skip to main content
GET
/
private-api
/
v1
/
{workspace_id}
/
farms
/
{farm_id}
/
tasks
/
batches
List Task Batches
curl --request GET \
  --url https://api.nonce.app/private-api/v1/{workspace_id}/farms/{farm_id}/tasks/batches \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "batch_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "task_name": "miner.log.get",
      "status": "pending",
      "task_count": 10,
      "succeed_count": 8,
      "failed_count": 2,
      "task_params": {},
      "created_by": {
        "type": "user",
        "id": "user_2xGz1234567890",
        "name": "John Doe",
        "avatar": "https://example.com/avatar.png",
        "metadata": {}
      },
      "created_at": "YYYY-MM-DDTHH:MM:SSZ"
    }
  ],
  "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

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
string

Filter by task name. Supports multiple values separated by comma. Task or event type dispatched to miners or agents. Execution types: miner.system.reboot, miner.log.get, miner.light.update, miner.power_mode.update, miner.pool.update, miner.pool.lock, miner.firmware.update, agent.scan.create, agent.self.update. Event types: miner.asset.update, miner.asset.delete, miner.rack_location.update.

Example:

"miner.system.reboot,miner.pool.update"

Response

Successfully retrieved task batches

​
success
boolean
required

Indicates if the request was successful

Example:

true

​
data
Task Batch Summary · object[]
required

Array of items

​
pagination
object
required

Pagination metadata

​
error
null
required

Error object (null on success)

Example:

null