API docs by Redocly

Eris Linux API (1.0.0)

Download OpenAPI specification:

Eris Linux Team: contact@eris-linux.net License: MIT

REST API for managing system services and configuration on Eris Linux embedded devices.

Eris Linux system documentation.

Contact

Periodic contact between the embedded system and the device manager.

Ask the device to contact the device manager immediately.

Responses

Get period between contacts to the Eris Linux server.

Responses

Set period in seconds between contacts to the Eris Linux server.

query Parameters
period
required
string

Period in seconds (in [0-86400]), 0 = no automatic contact.

Responses

Containers

Docker container related operations.

Get the maximal number of containers allowed.

Responses

Get the name of the container installed in a slot.

query Parameters
index
required
string

Index of the slot (in [0-3]).

Responses

Get the presence of a container in a slot.

query Parameters
index
required
string

Index of the slot (in [0-3]).

Responses

Get the status of a container in a slot.

query Parameters
index
required
string

Index of the slot ([0-3]).

Responses

Get the version of the container installed in a slot.

query Parameters
index
required
string

Index of the slot (in [0-3]).

Responses

Get the policy for container update.

Responses

Set the policy for container update.

query Parameters
policy
required
string

Policy for the container update (immediate or atreboot).

Responses

GPIO

General Purpose Input Output related requests.

Get the list of available GPIO.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Reserve a GPIO.

query Parameters
id
required
string

GPIO identifier as displayed in GET /api/gpio/list result.

direction
required
string

GPIO direction, must be 'in' or 'out'.

value
string

value to write if the direction is 'out' (must be '0' or '1').

Responses

Release a previously reserved GPIO line.

query Parameters
id
required
string

GPIO identifier as displayed in GET /api/gpio/list result.

Responses

Read the value of an input GPIO.

query Parameters
id
required
string

GPIO identifier as displayed in GET /api/gpio/list result.

Responses

Write a value to an output GPIO.

query Parameters
id
required
string

GPIO identifier as displayed in GET /api/gpio/list result.

value
required
string

Value to write (must be '0' or '1').

Responses

Reboot

System restart related features.

Force a system reboot as soon as possible.

Responses

Should the system reboot automatically after an update?

Responses

Indicates if the system must reboot automatically after update.

query Parameters
auto
required
string

Automatic reboot after a system update (yes or no).

Responses

Is there a system reboot pending?

Responses

Program or remove a pending reboot.

query Parameters
reboot
required
string

Program (yes) a system reboot or cancel (no) any pending reboot.

Responses

Force a system rollback to previous version at next reboot.

Responses

Return the device to factory preset at next reboot.

Responses

SBOM

Software Bill of Materials - informations about the packages installed on the system (not in containers).

Get a list of packages embedded in Eris Linux system.

Responses

Get the version number of a package installed on the Eris Linux system.

query Parameters
name
required
string

Name of the package, as returned in the list provided by GET /api/sbom/package-list.

Responses

Get the name of the recipe used to build a package.

query Parameters
name
required
string

Name of the package, as returned in the list provided by GET /api/sbom/package-list.

Responses

Get the list of licenses concerning a package and their logical relationships.

query Parameters
name
required
string

Name of the package, as returned in the list provided by GET /api/sbom/package-list.

Responses

Get a space-separated list of all licenses.

Responses

Get the full text of a license.

query Parameters
name
required
string

Name of the license as returned in the list provided by GET /api/sbom/license-list.

Responses

System

System related information.

Get the model of the board.

Responses

Get the type of the system image.

Responses

Get the UUID of the device.

Responses

Get the version the system.

Responses

Get the update status the system.

Responses

Time

Time, NTP and time zone related methods.

Get the name or IP address of the NTP server.

Responses

Set the name or IP address of the NTP server.

query Parameters
server
required
string

IP address or hostname of the NTP server.

Responses

Get the status of the NTP usage.

Responses

Set the status of the NTP usage.

query Parameters
status
required
string

Whether to use or not NTP protocol (yes or no).

Responses

Get a list of time zone names.

Responses

Get the local time zone of the device.

Responses

Set the local time zone of the device.

query Parameters
zone
required
string

Name of the time zone, must be one returned by GET /api/time/zone/list

Responses

Get the local time (using local time zone).

Responses

Get the system UTC time (regardless of local time zone).

Responses

Set the system UTC time.

query Parameters
time
required
string

System time in format YYYY/MM/DDThh:mm:ss or YYYY:MM:DD:hh:mm:ss.

Responses

Watchdog

Watchdog related operations.

Feed the watchdog.

Responses

Disable the watchdog.

Responses

Get the current delay of the watchdog.

Responses

Set the delay of the watchdog.

query Parameters
delay
required
string

Period in seconds (in [1-48]).

Responses

Get the status of the watchdog feeder thread.

Responses

Start the watchdog feeder thread.

Responses

Stop the watchdog feeder thread.

Responses

Network

Network interfaces status and setup.

Get the list of the network interfaces.

Responses

Get the current status of a network interface.

query Parameters
name
required
string

Name of the interface, as returned in the list provided by GET /api/network/interface/list.

Responses

Set the status of a network interface.

query Parameters
name
required
string

Name of the interface, as returned in the list provided by GET /api/network/interface/list.

status
required
string

Activation status of the interface (up or down).

Responses

Get the current configuration of a network interface.

query Parameters
name
required
string

Name of the interface, as returned in the list provided by GET /api/network/interface/list.

Responses

Set the configuration of a network interface.

query Parameters
name
required
string

Name of the interface, as returned in the list provided by GET /api/network/interface/list.

activate
required
string

When the interface must be activated (atboot or ondemand).

mode
required
string

Mode to obtain IP address (static or dhcp).

ip
string

Type of IP address (ipv4 or ipv6). Required if mode is static.

address
required
string

IP address of the interface. Required if mode is static.

netmask
required
string

IP mask of the sub-network of the interface. Required if mode is static.

gateway
required
string

IP address of the gateway to reach Internet. Required if mode is static.

Responses

Is this network interface wireless?.

query Parameters
name
required
string

Name of the interface, as returned in the list provided by GET /api/network/interface/list.

Responses

Get the current Domain Name Server address.

Responses

Set the address of the Domain Name Server.

query Parameters
address
required
string

IP address or host name of the DNS.

Responses

Scan the available Wifi SSID.

query Parameters
name
required
string

Name of the interface, as returned in the list provided by GET /api/network/interface/list.

Responses

Connect to a wifi access point.

query Parameters
name
required
string

Name of the interface, as returned in the list provided by GET /api/network/interface/list.

ssid
required
string

SSID of the Wifi access point to connect to.

pass
required
string

Password of the Wifi access point to connect to.

Responses

Disconnect from wifi access point.

Responses

Get statistics about wifi connection quality.

query Parameters
name
required
string

Name of the interface, as returned in the list provided by GET /api/network/interface/list.

Responses