UpdateWorkerNames | Proto Fleet Documentation

{
  "device_selector": {
    "selection_type": {
      "all_devices": {
        "device_status": [
          0
        ],
        "error_component_types": [
          0
        ],
        "models": [
          "example"
        ],
        "pairing_statuses": [
          0
        ],
        "group_ids": [
          42
        ],
        "rack_ids": [
          42
        ]
      }
    }
  },
  "name_config": {
    "properties": [
      {
        "kind": {
          "string_and_counter": {
            "prefix": "example",
            "suffix": "example",
            "counter_start": 42,
            "counter_scale": 42
          }
        }
      }
    ],
    "separator": "example"
  },
  "sort": [
    {
      "field": 0,
      "direction": 0
    }
  ],
  "user_username": "example",
  "user_password": "example"
}

Update worker names by applying a name config to all selected devices. Reapplies the miners' current pool settings first, then persists worker names only for miners whose pool updates succeed so Fleet stays aligned with device state.

UpdateWorkerNamesRequest

Request

This endpoint expects an object.

device_selectorobject

Selects which miners to update (specific IDs or all devices).

name_configobject

Naming pattern applied to the worker name that will be pushed to each selected miner and persisted back to Fleet after the device update succeeds.

sortlist of objects

Current fleet table sort used to assign counter order during generation. If omitted, the backend falls back to the default name ascending order.

user_usernamestring

Fleet user's username for authorization.

user_passwordstring

Fleet user's password for authorization.

UpdateWorkerNamesResponse

Response

This endpoint returns an object.

updated_countinteger

unchanged_countinteger

failed_countinteger

batch_identifierstring