API bundle

To use this functionality, run the following command in the karaf console:

The API is based on REST services. This means that functionality can be tested using CURL. This bundle consists of 4 services:

Show version

This displays the current Karaf distribution version. For example:

By REST (as POST). (username: admin password: admin). This can be done in Postman.

Or typing:

Gives the following output:

Feature list

This allows a list of features to be extracted without starting up karaf. Each feature must have the following properties:

name – version – repository – description – installed (boolean value, whether it is installed or not)

For example:

By REST (as GET). (username: admin password: admin). This can be done in Postman.

Or typing:

Gives the following output:

Monitor resources

This displays base information about system, memory and disk management

For example:

By REST (as POST). (username: admin password: admin). This can be done in Postman.

Or typing

Gives the following output:

Upload a KAR file

This function allows the user to easily upload any KAR file to the Karaf distribution. Before installing, the KAR file is validated. There is an HTTP servlet which listens on

The POST request contains one parameter which indicates the binary data of the KAR file. The parameter should be specified in base64 binary data format (as in the example curl command below).

For example the CURL has a function to convert file location to binary data. You can upload a KAR file by typing the following in a terminal:

where upload/dummy-1.0.0.kar is the path of the KAR file to be uploaded

This will give the following output which confirms that the file has been uploaded correctly:

Feature Guide
Feature introduced in FRINX 1.2.6 API bundle module