RenameMiners | 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
    }
  ]
}

Rename miners by applying a name config to all selected devices. Supports both single-miner and bulk rename via DeviceSelector. Persists all names atomically in a single transaction.

RenameMinersRequest

Request

This endpoint expects an object.

device_selectorobject

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

name_configobject

Naming pattern applied to all selected miners.

sortlist of objects

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

RenameMinersResponse

Response

This endpoint returns an object.

renamed_countinteger

unchanged_countinteger

failed_countinteger

1	{
2	"device_selector": {
3	"selection_type": {
4	"all_devices": {
5	"device_status": [
6	0
7	],
8	"error_component_types": [
9	0
10	],
11	"models": [
12	"example"
13	],
14	"pairing_statuses": [
15	0
16	],
17	"group_ids": [
18	42
19	],
20	"rack_ids": [
21	42
22	]
23	}
24	}
25	},
26	"name_config": {
27	"properties": [
28	{
29	"kind": {
30	"string_and_counter": {
31	"prefix": "example",
32	"suffix": "example",
33	"counter_start": 42,
34	"counter_scale": 42
35	}
36	}
37	}
38	],
39	"separator": "example"
40	},
41	"sort": [
42	{
43	"field": 0,
44	"direction": 0
45	}
46	]
47	}

1	{
2	"renamed_count": 42,
3	"unchanged_count": 42,
4	"failed_count": 42
5	}