Versioning

API versioning schema

The following versioning schema is used for all APIs.

Base URL

HOSTNAME/api/<module>/<version>

Examples:

HOSTNAME/api/power/0.1/
HOSTNAME/api/io/1.0/
HOSTNAME/api/bmc/0.11/

Versioning schema

The versioning schema follows the https://semver.org/ guidelines (MAJOR.MINOR.PATCH).

MAJOR The major number is increased if the API has incompatible changes. This version MUST be checked by all clients before using the API.

MINOR The minor number indicates that additional endpoints have been added to the API.

PATCH The patch number is incremented if non compatibility breaking changes are made.
It is not part of the URL but can be checked by using the /version endpoint.

Last modified October 22, 2021