Tray

Retrieve all Trays

Changed on

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 (rack-level vs component-level targeting)
  • 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

Request

  • Base URL
    https://nico-rest-api.nico.svc.cluster.local
  • URL
    https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/tray
  • Auth
    HTTP bearer

Query parameters

siteIdstring uuid required

ID of the Site to retrieve Trays from

rackIdstring

Filter by Rack ID

rackNamestring

Filter by Rack name

type'Compute' | 'NVSwitch' | 'PowerShelf'

Filter by tray type. When id is specified, the type disambiguates component IDs shared by different component types.

idstring

Filter by component ID. 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

One-indexed page number.

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. Defaults to NAME_ASC; equal field values are ordered by an immutable unique identifier to keep page boundaries stable.

Response

OK

idstring

Component ID

type'Compute' | 'NVSwitch' | 'PowerShelf' | 'Unknown'

Type of the tray. Unknown is reported when the component type is not recognized.

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

leakHandlingStatus'Unknown' | 'None' | 'ShuttingDown' | 'Down' | 'Failed'

Flow's leakage-handling status. Unknown means Flow could not determine the status; None means no supported handling task exists; ShuttingDown means a forced-shutdown task is waiting, pending, or running; Down means it completed; and Failed means the latest supported handling task failed or was terminated. Down describes handling progress, not the component's current power state.

rackIdstring

ID of the Rack this Tray belongs to

nvLinkDomainIdstring nullable required

Domain external ID (rack group ID) containing this Tray's Rack. Null when no rack-group Domain is assigned.

Example response

[
  {
    "id": "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",
    "leakStatus": "NoLeak",
    "leakHandlingStatus": "None",
    "position": {
      "slotId": 1,
      "trayIdx": 0,
      "hostId": 1
    },
    "bmcs": [
      {
        "type": "BmcTypeHost",
        "macAddress": "00:11:22:33:44:55",
        "ipAddress": "192.168.1.100"
      }
    ],
    "rackId": "rack-01",
    "nvLinkDomainId": "59202b81-65fb-45ec-b3b8-91ab0ad3f34a",
    "taskStats": {
      "pendingTaskCount": 3,
      "activeTaskCount": 1
    },
    "health": {
      "source": "aggregate-host-health",
      "observedAt": "2026-09-28T12:00:00Z",
      "successes": [],
      "alerts": []
    }
  }
]

Changes

  • 273aadbf1c41Revision changes
    • warning

      added the new Unknown enum value to the / response property for the response status

  • 293dc126ab73Revision changes
    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status