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

GetCollection

||View as Markdown|

Example request

1 {
2   "collection_id": 42
3 }

Example response

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

Gets a collection by ID

GetCollectionRequest

Request

This endpoint expects an object.

collection_idlong

ID of the collection to retrieve

GetCollectionResponse

Response

This endpoint returns an object.

collectionobject

The requested collection