Info API

Info API

The Info API provides application metadata and configuration information.

Base Path: /info


Endpoints

GET /info

Returns the application version.

Purpose: Get the current version of the CIB ins7ght application.

Parameters: None

Response Example:

0.0.2-SNAPSHOT

Response Type: text/plain

Response Format:

  • For release versions: Version number (e.g., 0.0.2)
  • For snapshot versions: Version number with build timestamp (e.g., 0.0.2-SNAPSHOT 2025-01-29-1200)

GET /info/properties

Returns application configuration properties.

Purpose: Get frontend-relevant configuration properties such as the CIB Seven webclient URL.

Parameters: None

Response Example:

{
  "webclientCockpitUrl": "http://localhost:8080/webapp/#/seven/auth/processes/dashboard"
}

Response Fields:

Field Type Description
webclientCockpitUrl string URL to CIB Seven webclient dashboard

Usage Examples

Get Application Version

curl -X GET "http://localhost:8899/info"

Response:

0.0.2-SNAPSHOT 2025-01-29-1200

Get Configuration Properties

curl -X GET "http://localhost:8899/info/properties"

Response:

{
  "webclientCockpitUrl": "http://localhost:8080/webapp/#/seven/auth/processes/dashboard"
}

Notes

  • The /info endpoint returns plain text, not JSON
  • The version includes build timestamp for snapshot builds
  • The webclientCockpitUrl property is configured in application.yaml
  • These endpoints are typically used by the frontend for initialization

On this Page: