Luxor Documentation Hub Logo
Luxor Platform/API Documentation/Commander

Get agents

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

GET
/v2/commander/agents

Authorization

authorization<token>

Use your API key here.

In: header

Query Parameters

site_idstring
Format: "uuid"
statusstring
Value in: "enabled" | "disabled"
sort_bystring
Value in: "name" | "created_at" | "last_seen_at"
sort_orderstring
Default: "asc"Value in: "asc" | "desc"
page_numberinteger
Default: 1Minimum: 1
page_sizeinteger
Default: 25Minimum: 1
curl -X GET "https://app.luxor.tech/api/v2/commander/agents?site_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&status=enabled&sort_by=name&sort_order=asc&page_number=1&page_size=25" \
  -H "authorization: <token>"

Default Response

{
  "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
  }
}

Previous

Create action

Next

Create agent