Tray

Retrieve a Tray

Changed on

Get a Tray by component ID or component MAC address.

The identifier must resolve to exactly one component. An ambiguous component ID returns 412 Precondition Failed; use the component MAC address to disambiguate it.

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

get/v2/org/{org}/nico/tray/{id}

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/{id}
  • Auth
    HTTP bearer

Query parameters

siteIdstring uuid required

ID of the Site

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

    • 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