As more customers begin planning their transition from BioStar 2 to BioStar X, one of the most common questions we receive is how the upgrade will affect existing API-based integrations. This article summarizes the key compatibility considerations and highlights the only known API change that may require developer action.

Overall API Compatibility

The good news:
Most APIs used in BioStar 2 continue to work in BioStar X without any modification.

Even where new fields or structures have been added, these additions do not interfere with existing BioStar 2 integrations. In the majority of cases, integrations built on BioStar 2 REST APIs can transition smoothly to BioStar X.

Important Exception: /api/setting/biostar Response Body Field 'licenses' Structure Change

There is one API endpoint where compatibility differs between BioStar 2 and BioStar X:

GET /api/setting/biostar

Within the response body of this API, the structure of the licenses field has changed in BioStar X.
This modification means that integrations relying on the licenses field must be reviewed and updated when migrating.


BioStar X licenses Field Structure

"licenses": {

            "base": {

                "id": ,

                "prodName": ""

            },

            "capacity": {

                "door": 0,

                "user": 0,

                "operator": 0

            },

            "feature": {

                "commServerBase": false,

                "commServerAddonCount": 0,

                "videoCount": 0,

                "serverMatching": false,

                "api": false,

                "visitor": false,

                "tna": {

                    "standard": false,

                    "enterprise": false

                },

                "remoteAccess": false,

                "activeDirectory": false,

                "rollCall": false,

                "gisMap": false,

                "mobile": false,

                "plugin": false,

                "evtLogApi": false,

                "advancedAcs": false

            }

        }



If your application parses or depends on the licenses field information returned by this endpoint, please ensure you update your logic accordingly before completing your migration to BioStar X. Failing to adjust this portion may lead to parsing errors or system malfunction.

API Documentation Notes

You can access the full BioStar X API documentation here: BioStar X API Doc

Please note:

  • If certain APIs are not listed in this doc, it means they are not yet open for public use in BioStar X.

  • Additional endpoints and features will continue to be released, so we encourage checking the documentation periodically.

  • Release Notes for each version are also recorded in the doc.

Need Assistance?

If you have any questions regarding the BioStar X API, please submit a ticket through our official support channel: Support Page