Chapter 16: About Information

Home Prev	cOS Core 15.00.01 REST API Guide	Next

Using the REST API, a program running on an external computer is able to retrieve the version of cOS Core that is currently running, as well as information about the underlying computing platform. The reply is sent back by cOS Core in JSON format.

Sending the About Request

To retrieve the information, an HTTP GET should be sent to the following URI:

/api/about

The GET has no optional parameters.

The About Information Returned

The following is a list of the values sent back in the JSON reply:

error - This is false if the request was successful.
version - The full version number of the cOS Core software.
version_numbers - The version number broken down into its parts.
buildtype - This usually has the value Release unless the version a technical preview.
vendor- The system vendor. This will usually be Clavister.
product - The name of the system software. This will usually be cOS Core.
model - The platform on which the software is running.
device_name - The name that has been assigned to the device.

The default name will be Device if it has not been previously changed.

An Example JSON Reply

Below is an example of a typical JSON reply:

{
  "error": false,
  "version": "12.00.12.03-12345",
  "version_numbers": [
     12,
     0,
     12,
     3,
     12345
  ],
  "buildtype": "Release",
  "vendor": "Clavister",
  "product": "cOS Core",
  "model": "E10",
  "device_name": "MyDevice"
}