Luxor Documentation Hub Logo
Luxor Platform/API Documentation/Commander

Update agent

Updates an existing Commander agent. Editable fields: name, status, scan_ranges, firmware_credentials.

PATCH
/v2/commander/agents/{agent_id}

Authorization

authorization<token>

Use your API key here.

In: header

Request Body

application/jsonOptional
namestring
Minimum length: 1
statusstring
Value in: "enabled" | "disabled"
scan_rangesarray<object>
firmware_credentialsarray<object>

Path Parameters

agent_idRequiredstring

Agent UUID

Format: "uuid"
curl -X PATCH "https://app.luxor.tech/api/v2/commander/agents/1d786ea1-9400-4566-94be-d5f400e0490b" \
  -H "authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "status": "enabled",
    "scan_ranges": [
      {
        "type": "ip_range",
        "value": "string"
      }
    ],
    "firmware_credentials": [
      {
        "firmware": "Whatsminer",
        "username": "string",
        "password": "string"
      }
    ]
  }'

Default Response