Luxor PlatformAPI DocumentationCommanderAgents

Get agents

Returns a paginated list of Commander agents with optional filtering by site and status.

GET
/v2/commander/agents

Authorization

LuxorAPIKey
authorization<token>

Use your API key here.

In: header

Query Parameters

site_id?string
Formatuuid
status?string

Value in

  • "enabled"
  • "disabled"
sort_by?string

Value in

  • "name"
  • "created_at"
  • "last_seen_at"
sort_order?string
Default"asc"

Value in

  • "asc"
  • "desc"
page_number?integer
Range1 <= value
Default1
page_size?integer
Range1 <= value
Default25

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v2/commander/agents"
{  "agents": [    {      "id": "1d786ea1-9400-4566-94be-d5f400e0490b",      "name": "blocklab-agent-001",      "site_id": "b0a5fad8-1234-5678-9abc-def012345678",      "status": "enabled",      "version": "v0.20.0",      "plan": "pro",      "scan_ranges": [        {          "type": "ip_range",          "value": "10.206.0.1-100"        }      ],      "firmware_credentials": [        {          "firmware": "Bitmain",          "username": "root",          "password_set": true        }      ],      "miners_count": 512,      "last_seen_at": "2026-04-20T10:15:00Z",      "created_at": "2025-11-02T09:30:00Z",      "url": "/v2/commander/agents/1d786ea1-9400-4566-94be-d5f400e0490b"    }  ],  "pagination": {    "page_number": 1,    "page_size": 1,    "item_count": 0,    "previous_page_url": null,    "next_page_url": null  }}
{  "statusCode": 400,  "code": "FST_ERR_VALIDATION",  "error": "Bad Request",  "message": "body/end_date Required"}
{  "statusCode": 400,  "code": "FST_ERR_VALIDATION",  "error": "Bad Request",  "message": "body/end_date Required"}

Create action

Creates a bulk miner action (execution plan) such as reboot, sleep, wake up, or configuration changes. 'Change Temperature Control' requires at least one params.temp_control field, temperatures are in degrees Celsius, and fields a miner model doesn't support are ignored. Thresholds sent together are checked server-side and rejected with 400 if out of order: chip target, hot and dangerous must ascend, and water-inlet hot and startup must not exceed water-inlet dangerous. Its fields dispatch as two groups — the ATM group (enabled, startup_minutes, post_ramp_minutes, minimum_profile, maximum_profile, chip_temperature_buffer, water_inlet_temperature_buffer) and the threshold group (everything else) — and a request spanning both produces two Action Log entries, of which the response returns one; find the sibling with GET /v2/commander/actions. Setting any ATM-group field requires the same subscription entitlement as 'Change ATM Settings' (403 otherwise). Both 'Change ATM Settings' and 'Change Temperature Control' can appear as a response action_type, because the two share a downstream step type: an ATM request may read back as 'Change Temperature Control'.

Create agent

Provisions a new Commander agent. The caller provides the agent secret.