API ReferenceTray

Retrieve all Trays

View as Markdown
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

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

Query parameters

siteIdstringRequiredformat: "uuid"
ID of the Site to retrieve Trays from
rackIdstringOptionalformat: "uuid"
Filter by Rack ID
rackNamestringOptional
Filter by Rack name
typeenumOptional
Filter by tray type
Allowed values:
componentIdstringOptional
Filter by component ID. Can be specified multiple times to filter on more than one component ID. Requires 'type' parameter.
idstringOptionalformat: "uuid"
Filter by tray UUID. Can be specified multiple times to filter on more than one tray ID.
slotIdintegerOptional>=0

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

pageNumberintegerOptional>=1Defaults to 1
Page number for pagination query
pageSizeintegerOptional1-100
Page size for pagination query
orderByenumOptional
Ordering for pagination query

Response headers

X-Paginationstring
Pagination result in JSON format

Response

OK
idstringformat: "uuid"
Unique identifier of the Tray
componentIdstring
ID of the component
typeenum
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
operationStatusenum

Flow-derived operability phase of the tray

leakStatusenum
Whether the tray is considered leaking coolant
positionobject
Position of the Tray within the Rack
bmcslist of objects

BMC (Baseboard Management Controller) entries for the tray

rackIdstringformat: "uuid"
ID of the rack this tray belongs to

Errors

403
Forbidden Error