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.

Home Guides API Reference

Home Guides API Reference

API Reference

API Reference device_set.v1 DeviceSetService

ListDeviceSets

||View as Markdown|

Example request

1 {
2   "type": 0,
3   "page_size": 42,
4   "page_token": "example",
5   "sort": {
6     "field": 0,
7     "direction": 0
8   },
9   "error_component_types": [
10     0
11   ],
12   "zones": [
13     "example"
14   ]
15 }

Example response

1 {
2   "device_sets": [
3     {
4       "type_details": {
5         "rack_info": {
6           "rows": 42,
7           "columns": 42,
8           "zone": "example",
9           "order_index": 0,
10           "cooling_type": 0
11         }
12       },
13       "id": 42,
14       "type": 0,
15       "label": "example",
16       "description": "example",
17       "device_count": 42,
18       "created_at": {
19         "seconds": 42,
20         "nanos": 42
21       },
22       "updated_at": {
23         "seconds": 42,
24         "nanos": 42
25       }
26     }
27   ],
28   "next_page_token": "example",
29   "total_count": 42
30 }

Lists all device sets for the organization

ListDeviceSetsRequest

Request

This endpoint expects an object.

typeenum

Filter by device set type (optional, returns all types if unspecified)

Allowed values:

page_sizeinteger

Maximum number of device sets to return (0 = server default)

page_tokenstring

Pagination cursor from a previous response

sortobject

Sort configuration (defaults to name ascending). Supported fields: SORT_FIELD_NAME, SORT_FIELD_DEVICE_COUNT.

error_component_typeslist of enums

Filter by device sets containing devices with open errors of these component types. When non-empty, only device sets with at least one device having an open error matching any of the specified component types are returned.

zoneslist of strings

Filter by rack zones. Only valid when type is RACK. When non-empty, only racks in any of the specified zones are returned.

ListDeviceSetsResponse

Response

This endpoint returns an object.

device_setslist of objects

List of device sets ordered by label

next_page_tokenstring

Cursor for the next page, empty if no more results

total_countinteger

Total number of device sets matching the request filters