Module RESTful API

RESTful-API documentation including usage examples

The API allows you to use the function of each module.
The basic components like URL structure, versioning and error handling are generic over all modules.

Guide for rapid implementation

This guide is intended to enable a quick implementation and explain the most important points.

  1. Implement the version check and device selection.
    This point is very important because we don’t want problematic implementations that go crazy after an update!
  2. Implement proper error handling.
  3. After the version check and device selection reset the device to initial state using /reset.
    This is not needed if the application uses only “read” requests.
  4. Start by implementing all the GET requests and proceed with POST requests later.
  5. Some functions like /hard_reset, /watchdog or /limits can reset the entire system.
    We do not recommend to implement them if they are not needed by the application!
  6. Implement the /notification endpoint if it is required by the documentation.

Important notes


Version check and device selection

Describes the /version and /descriptor endpoints.

Error response handling

Describes how errors should be handled.

IO Module

IO Module RESTful API documentation

Mainboard (BMC)

Mainboard RESTful API documentation

Power Module

Power Module RESTful API documentation

Versioning

API versioning schema

Last modified October 22, 2021