Jump to

• Request
• Response

Get hardware entity information

get

/rest/{version}/system/hardware

Retrieves various hardware entity information such as chassis, CPU model, main board, network ports, power supplies, fan units, and other hardware-related information. Only supported on hardware SBCs, not virtual SBCs.

Request

Path Parameters

• version(required):
  REST API version string.
  Available values: v1.2

Header Parameters

• Authorization(required):
  The value in the Authorization header must be the string "Bearer {access token}", where {access token} is a valid, unexpired token received in response to a prior /rest/{version}/auth/token request.

Back to Top

Response

200 Response

OK - Requested data is returned in response body

400 Response

The request is malformed in some way or is missing required information and therefore cannot be processed.

401 Response

Unauthorized - Request lacks valid authentication credentials.

404 Response

Resource not found

Back to Top