Apps API

An AuterionOS app can use multiple APIs. The available APIs are determined by the target AuterionOS version, as well as the used API level specified in the app.

Specifying API versions

Each AuterionOS app targets a specific API level. The API level an app targets, is specified in the auterion-app.yml file like so:

auterion-api-version: 2

Available API versions

The following table identifies the feature sets of the different Auterion Apps API versions. Both versions are supported by auterion-cli, but apps targeting older versions of AuterionOS will have to be restricted to older API versions.

Minimum AuterionOS version per API level

Newer versions of the Apps API are supported by more recent AuterionOS releases.

Apps API Version	Minimum AuterionOS
v1	2.7
v2	2.10
v3	3.2.9

Feature comparison of API versions

Feature	API v1	API v2	API v3	API v4
Host Docker Network
Virtual Docker Network, bridged
Sensor Data
Video Stream
Photos
Hardware Peripherals
Persistent storage
MAVLink
Native Docker Compose
App settings
User Web Interfaces
Debugging Apps with SSH
DDS/ROS2 Configuration
Build Arguments
Logging App messages
Auterion SDK

For now, all API versions are supported. Some future versions of AuterionOS may lose support for older API versions. APIs within their version are stable, but APIs may change with newer API versions.