Skip to main content
GET
List Task Batches

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
enum<string>[]

Filter by one or more task names separated by commas.

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.ip_diagnosis.create, agent.self.update. Event types: miner.tags.update, miner.record.delete, miner.rack_location.update.

Available options:
agent.scan.create,
agent.ip_diagnosis.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.tags.update,
miner.record.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