Sign in

v57

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-012143051018.3 KB
Tray

Retrieve all Trays

Get all Trays (components) for the specified Site.

Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

Filter constraints:

  • rackId and rackName are mutually exclusive
  • rackId/rackName cannot be combined with id/componentId (rack-level vs component-level targeting)
  • componentId requires type to be specified
  • slotId restricts to trays at that rack slot, requires rackId or rackName, and composes with the rest of the query via AND
get/v2/org/{org}/nico/tray

Query parameters

siteIdstring uuid required

ID of the Site to retrieve Trays from

rackIdstring uuid

Filter by Rack ID

rackNamestring

Filter by Rack name

type'compute' | 'switch' | 'powershelf'

Filter by tray type

componentIdstring

Filter by component ID. Can be specified multiple times to filter on more than one component ID. Requires 'type' parameter.

idstring uuid

Filter by tray UUID. Can be specified multiple times to filter on more than one tray ID.

slotIdinteger

Restrict to trays at this rack slot (matches position.slotId). Requires rackId or rackName. Composes with the rest of the filter via AND.

pageNumberinteger
Example:1

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBy'NAME_ASC' | 'NAME_DESC' | 'MANUFACTURER_ASC' | 'MANUFACTURER_DESC' | 'MODEL_ASC' | 'MODEL_DESC' | 'TYPE_ASC' | 'TYPE_DESC'

Ordering for pagination query

Response

OK

idstring uuid

Unique identifier of the Tray

componentIdstring

ID of the component

type'compute' | 'switch' | 'powershelf'

Type of the tray

namestring

Name of the tray

manufacturerstring

Manufacturer of the tray

modelstring

Model of the tray

serialNumberstring

Serial number of the tray

descriptionstring

Description of the tray

firmwareVersionstring

Firmware version of the tray

powerStatestring

Current power state of the tray

operationStatus'Unknown' | 'Initializing' | 'Ready' | 'InUse' | 'Error' | 'Deleting'

Flow-derived operability phase of the tray

leakStatus'Unknown' | 'NoLeak' | 'Leaking'

Whether the tray is considered leaking coolant

rackIdstring uuid

ID of the rack this tray belongs to

Example response

[
  {
    "id": "660e8400-e29b-41d4-a716-446655440001",
    "componentId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
    "type": "compute",
    "name": "compute-tray-1",
    "manufacturer": "NVIDIA",
    "model": "GB200",
    "serialNumber": "TSN001",
    "description": "Compute tray in slot 1",
    "firmwareVersion": "2.1.0",
    "powerState": "on",
    "position": {
      "slotId": 1,
      "trayIdx": 0,
      "hostId": 1
    },
    "bmcs": [
      {
        "type": "BmcTypeHost",
        "macAddress": "00:11:22:33:44:55",
        "ipAddress": "192.168.1.100"
      }
    ],
    "rackId": "550e8400-e29b-41d4-a716-446655440000"
  }
]