version Endpoint¶

The version endpoint shows version information for various software components, including BrainStem version, BrainD version, and build information.

There are no input parameters to this endpoint. It will return a JSON object as described below. This endpoint does not use a transaction envelope. Contents are returned exactly as described in the schema below.

JSON Schema for Response Object¶

The following table lists a JSON Schema for the response object.

Download the raw JSON Schema file for this response: get_version_response.json

Object Fields of Get Version Response¶

Name	Type	Mandatory	Description
`braind`	v1-buildInfo	Yes	Version and Build Information for the braind daemon.
`brainstem`	v1-buildInfo	Yes	Version and Build Information for the BrainStem library.
`controlRoom`	v1-buildInfo	No	Version and Build Information for the Control Room application.

v1-version¶

Name	Value
Type	Object
description	Object representing a <major>.<minor>.<patch> semantic version.

Name	Type	Mandatory
`major`	v1-uint8	Yes
`minor`	v1-uint8	Yes
`patch`	v1-uint8	Yes

v1-buildInfo¶

Name	Value
Type	Object
description	Version and Build Information for an arbitrary software component.

Name	Type	Mandatory	Description
`version`	v1-version	Yes
`buildDate`	string	No	Date and Time that this software component was built.
`buildHash`	string	No	Hexadecimal Git commit ID that was used for this build.

v1-uint8¶

Name	Value
Type	integer
description	Unsigned 8-bit integer
minimum	0
maximum	255

Examples¶

curl http://127.0.0.1:9005/api/v1/version

import requests
import json
response = requests.get('http://127.0.0.1:9005/api/v1/version')
json_data = response.json()
print(json.dumps(json_data, indent=4))

The output will be similar to the following:

{
    "braind": {
        "version": {
            "major": 1,
            "minor": 0,
            "patch": 1
        },
        "buildDate": "Wed Aug 23 13:35:12 2023",
        "buildHash": "b1ba5c6153b7fbbb65c868b65c8ac70bb3d7b7dd"
    },
    "brainstem": {
        "version": {
            "major": 2,
            "minor": 10,
            "patch": 0
        },
        "buildDate": "2023-09-11T17:14:25Z",
        "buildHash": "7af9c07e44601d6987fe3dab0ea201a13609683e"
    }
}