Project API

Jump to Section

The Configuration API supports routes for importing/exporting full or partial projects. This can be useful in performing CI/CD deployments, backing up configuration, and performing mass configuration. The API endpoints are documented below.

Get Info

The get info route returns basic information about the Intelligence Hub like version, licensing, etc. It does not require authorization.

Method: GET
URL: http://localhost:45245/v1/info
Return: {"companyName":"HighByte","productName":"IntelligenceHub","productVersion":"4.0.0","productBuild":"2024.9.23.535","productStage":"Alpha","features":["centralConfig"],"license":{"isLicensed":false}}

Authentication

Almost all of the API routes require authentication using a bearer token. To retrieve a bearer token, login using a username and password.

Method: POST
URL: http://localhost:45245/login
Body: {"username": "administrator", "password": ""}
Return: {"success": true, "message": null, "token": "Bearer 5af23835-ea58-43eb-9da2-41ef9bd3e1d8"}

Include the bearer token in API requests the require login as Authorization: Bearer 5af23835-ea58-43eb-9da2-41ef9bd3e1d8.

Project Export

Use this route to export the full project in JSON format.

Method: GET
URL: http://localhost:45245/v1/project/export
Return: Full JSON of the current configuration

Project Import

Use this route to import a full or partial project in JSON format.

Method: POST
URL: http://localhost:45245/v1/project/import
Body: A project in JSON format. Use the Project Export route or Project Export in the UI to see examples.
Return: Success/failure of each imported object in JSON format

Use this route to import a partial project in JSON format. This will merge the existing project with the new project, and update any objects with the same name.

Method: POST
URL: http://localhost:45245/v1/project/partial/import
Body: A full or partial project in JSON format. Use the Project Export route or Project Export in the UI to see examples.
Return: Success/failure of each imported object in JSON format

Troubleshooting