Skip to main content
POST
/
private-api
/
v1
/
{workspace_id}
/
farms
/
{farm_id}
/
tasks
/
batches
Create Task Batch
curl --request POST \
  --url https://api.nonce.app/private-api/v1/{workspace_id}/farms/{farm_id}/tasks/batches \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "task_name": "miner.system.reboot",
  "miner_ids": [
    "<string>"
  ],
  "params": {
    "force": true
  }
}
'
{
  "success": true,
  "data": [
    {
      "batch_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "task_name": "miner.log.get",
      "task_count": 10,
      "created_by": {
        "type": "user",
        "id": "user_2xGz1234567890",
        "name": "John Doe",
        "avatar": "https://example.com/avatar.png",
        "metadata": {}
      },
      "created_at": "YYYY-MM-DDTHH:MM:SSZ"
    }
  ],
  "error": null,
  "meta": {
    "summary": {
      "created_count": 123,
      "skipped_count": 123
    },
    "skipped": [
      {
        "reason": "no_change",
        "message": "<string>",
        "miner_ids": [
          "<string>"
        ]
      }
    ]
  }
}

Authorizations

x-api-key
string
header
required

Legacy Private API Key for authentication

Path Parameters

workspace_id
string
required
farm_id
string
required

Body

application/json
task_name
enum<string>
required

Task type: Reboot miner system

Available options:
miner.system.reboot
miner_ids
string[]
required
Required array length: 1 - 100 elements
params
object

Reboot parameters

Response

Successfully created task batches

success
boolean
required

Indicates if the request was successful

Example:

true

data
Miner Task Batch · object[]
required

Array of items

error
null
required

Error object (null on success)

Example:

null

meta
Create Task Batch Meta · object
required