For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGuidesAPI Reference
HomeGuidesAPI Reference
  • API Reference
        • UNARYCreateDeviceSet
        • UNARYGetDeviceSet
        • UNARYUpdateDeviceSet
        • UNARYDeleteDeviceSet
        • UNARYListDeviceSets
        • UNARYAddDevicesToDeviceSet
        • UNARYRemoveDevicesFromDeviceSet
        • UNARYListDeviceSetMembers
        • UNARYGetDeviceDeviceSets
        • UNARYSetRackSlotPosition
        • UNARYClearRackSlotPosition
        • UNARYGetRackSlots
        • UNARYGetDeviceSetStats
        • UNARYListRackZones
        • UNARYListRackTypes
        • UNARYSaveRack
LogoLogo
API Referencedevice_set.v1DeviceSetService

CreateDeviceSet

||View as Markdown|
Example request
1{
2  "type_details": {
3    "rack_info": {
4      "rows": 42,
5      "columns": 42,
6      "zone": "example",
7      "order_index": 0,
8      "cooling_type": 0
9    }
10  },
11  "_device_selector": {
12    "device_selector": {
13      "selection_type": {
14        "device_list": {
15          "device_identifiers": [
16            "example"
17          ]
18        }
19      }
20    }
21  },
22  "type": 0,
23  "label": "example",
24  "description": "example"
25}
Example response
1{
2  "device_set": {
3    "type_details": {
4      "rack_info": {
5        "rows": 42,
6        "columns": 42,
7        "zone": "example",
8        "order_index": 0,
9        "cooling_type": 0
10      }
11    },
12    "id": 42,
13    "type": 0,
14    "label": "example",
15    "description": "example",
16    "device_count": 42,
17    "created_at": {
18      "seconds": 42,
19      "nanos": 42
20    },
21    "updated_at": {
22      "seconds": 42,
23      "nanos": 42
24    }
25  },
26  "added_count": 42
27}
Creates a new device set
Built with

CreateDeviceSetRequest

Request
This endpoint expects an object.
type_detailsobject
_device_selectorobject
typeenum

Type of device set to create (required)

Allowed values:
labelstring

Label for the device set (required, 1-100 characters)

descriptionstring

Optional description (max 500 characters)

CreateDeviceSetResponse

Response
This endpoint returns an object.
device_setobject
The newly created device set
added_countinteger

Number of devices added to the device set (0 if no device_selector was provided)