Skip to navigation
API ReferenceTray

Retrieve a Tray

View as Markdown

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.

Authentication

AuthorizationBearer
export JWT_BEARER_TOKEN="<jwt-bearer-token>"

# Example org name: "acme-inc
export ORG_NAME=<org-name>

# Use the JWT bearer token in your API request auth header:
curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current

Path parameters

orgstringRequired
Name of the Org
idstringRequired
Component ID or component MAC address

Query parameters

siteIdstringRequiredformat: "uuid"
ID of the Site

Response

OK
nvLinkDomainIdstring or null

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

taskStatsobject

Counts of non-terminal tasks currently associated with a rack or tray. Rack stats include component-scoped tasks on the rack; tray stats include only tasks that explicitly target the tray.

healthobject or null
Latest Core aggregate health snapshot synchronized by Flow. Null when Core reports no aggregate health, including before the first successful inventory sync.
idstringOptional
Component ID
typeenumOptional

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

Allowed values:
namestringOptional
Name of the tray
manufacturerstringOptional
Manufacturer of the tray
modelstringOptional
Model of the tray
serialNumberstringOptional
Serial number of the tray
descriptionstringOptional
Description of the tray
firmwareVersionstringOptional
Firmware version of the tray
powerStatestringOptional
Current power state of the tray
operationStatusenumOptional

Flow-derived operability phase of the tray

leakStatusenumOptional
Whether the tray is considered leaking coolant
Allowed values:
leakHandlingStatusenumOptional

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.

Allowed values:
positionobjectOptional
Position of the Tray within the Rack
bmcslist of objectsOptional

BMC (Baseboard Management Controller) entries for the tray

rackIdstringOptional
ID of the Rack this Tray belongs to

Errors

403
Forbidden Error
404
Not Found Error
412
Precondition Failed Error
504
Gateway Timeout Error