Retrieve a Tray

View as Markdown

Get a Tray by ID.

Org must have an Infrastructure Provider entity. User must have FORGE_PROVIDER_ADMIN authorization role.

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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current ```

Path parameters

orgstringRequired
idstringRequired

Query parameters

siteIdstringRequiredformat: "uuid"
ID of the Site

Response

OK
idstringformat: "uuid"
Unique identifier of the Tray
componentIdstring
ID of the component
typeenum
Type of the tray
Allowed values:
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
positionobject
Position of a tray within a 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
404
Not Found Error