For AI agents: a documentation index is available at the root level at /llms.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 collection.v1 DeviceCollectionService

GetDeviceCollections

||View as Markdown|

Example request

1 {
2   "device_identifier": "example",
3   "type": 0
4 }

Example response

1 {
2   "collections": [
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 }

Gets collections that a device belongs to

GetDeviceCollectionsRequest

Request

This endpoint expects an object.

device_identifierstring

Device identifier to look up

typeenum

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

GetDeviceCollectionsResponse

Response

This endpoint returns an object.

collectionslist of objects

Collections the device belongs to, ordered by label