Version

Show the lowsynx version number, the build target OS and architecture, and the runtime OS.

Version Api options

note

This api doesn't have any options.

Calling Version Api

For calling this api, the following details are required to apply:

URL	Method
http://localhost:5860/version	GET

Now, if we want to have these details in the form of an http api call, open a new terminal and enter the following command:

info

First of all make sure flowsynx is running.

HTTP API (Bash)

curl -X GET http://localhost:5860/version

HTTP API (PowerShell)

Invoke-RestMethod -Method Get -Uri 'http://localhost:5860/version'

Also you can use Http Api test clients to test this api. Anyway, after executing this api, a result like below will be obtained.

{
  "data": {
    "flowSynx": "0.1.0",
    "osVersion": "Microsoft Windows 10.0.19045 (64 bits)",
    "osArchitecture": "X64",
    "osType": "Windows"
  },
  "messages": [],
  "succeeded": true
}

The answer is divided into three data, messages, and succeeded parts. succeeded indicates the status of the execution of this api which is boolean value and can be true or false. messages also indicates the list of possible messages that are returned with the response. data contains the data to be returned.

info

data part will have a value only when succeeded is true. If succeeded is false, this field will be null.

The information including in the result for this api is described as follows:

flowSynx: Refer to the version of current running flowsynx.
osVersion: Refer to the full version of current Operating System that flowsynx running on.
osArchitecture: Refer to the architecture of current Operating System that flowsynx running on (e.g., x32, x64, etc.).
osType: Refer to the type of current Operating System that flowsynx running on (e.g., Windows, Linux, MacOS).