API Gateway App Release Notes

The initial installation of ITRS Analytics includes all required app, such as the Web Console, bundled by default. No separate installation steps are required for individual apps. For installation guidance, refer to the Install ITRS Analytics apps documentation.

To stay informed about the most recent updates and packaging versions, you can refer to the ITRS Analytics Packaging Changelog. This resource provides direct links to release notes for each bundled version of the ITRS Analytics Platform and its apps, bill of materials listing all included components, and references to the published Docker images.

API Gateway 2.8.0 Copied

Released: 2 December 2025

New features and enhancements Copied

These are the new features and enhancements of this release:

Issue key Release description
HAPA-331 Added support for installing the app in secured Kubernetes clusters.

API Gateway 2.7.2 Copied

Released: 30 October 2025

New features and enhancements Copied

These are the new features and enhancements of this release:

Issue key Release description
HAPA-296 The app name has been corrected and restored to API, where it was previously displayed as Core.
HAPA-212 Reduced the default CPU request from 200 millicores to 100 millicores.
HAPA-276

Added V2 endpoints for the following APIs:

Lookup APIs:

  • POST /lookup/names – Discover available dimensions, attributes, and metric names.
  • POST /lookup/values – Retrieve all possible values for specific dimensions or attributes.

Entity APIs:

  • POST /entities – Fetch entities (nodes, pods, containers, VMs) with complete dimension hierarchies, attributes, and available metrics.

Metrics APIs:

  • POST /metrics – Retrieve bucketed time-series data with configurable granularity (from 10-second to 5-minute intervals) and support for statistical aggregations.
  • POST /status-metrics/latest – Get the latest status metrics (OK, WARNING, ERROR, CRITICAL) for real-time health monitoring.

Analytics APIs:

  • POST /analytics/summary-statistics – Calculate aggregate statistics across entities.
  • POST /analytics/grouped-summary-statistics – Compute grouped statistics by dimensions or attributes for comparative analysis.
  • POST /analytics/models/seasonal – Generate seasonal patterns and trends for forecasting and anomaly detection.

Issues fixed Copied

These are the issues we have fixed in this release:

Issue key Release description
HAPA-308 Reverted the app’s license entitlement ID to accurately reflect its correct license status and ensure proper license validation.
HAPA-261 Updated Spring Framework to version 3.5.6 to address a high-severity security vulnerability CVE-2025-41249.

API Gateway 2.6.0 Copied

Released: 7 May 2025

New features and enhancements Copied

These are the new features and enhancements of this release:

Issue key Release description
HAPA-209 Upgraded ITRS Analytics Platform to version 2.11.0.

Issues fixed Copied

These are the issues we have fixed in this release:

Issue key Release description
HAPA-185 Fixed an issue where the address used for legacy endpoints was incorrect.

API Gateway 2.5.1 Copied

Released: 28 March 2025

Issues fixed Copied

These are the issues we have fixed in this release:

Issue key Release description
HAPA-185 Fixed an issue where the address used for legacy endpoints was incorrect.

API Gateway 2.5.0 Copied

Released: 19 March 2025

New features and enhancements Copied

These are the new features and enhancements of this release:

Issue key Release description
HAPA-170 Added the label app.kubernetes.io/part-of: obcerv to all Kubernetes workloads.
HAPA-184 The following endpoints have been deprecated:
  • /api/metrics/GetStatusMetrics
  • /api/metrics/GetMetrics
  • /api/metrics/GetMetricMetadata
  • /api/metrics/GetLatestStatusMetrics
  • /api/metrics/GetLatestMetrics
  • /api/entity/GetEntities
  • /api/entity/GetNames
  • /api/entity/GetEntities

Issues fixed Copied

These are the issues we have fixed in this release:

Issue key Release description
HAPA-171 Fixed an issue that caused the browser to time out while waiting to load the API details.

API Gateway 2.4.0 Copied

Released: 27 February 2025

New features and enhancements Copied

These are the new features and enhancements of this release:

Issue key Release description
HAPA-157 Updated the title of the API landing page to ITRS Public API.

Issues fixed Copied

These are the issues we have fixed in this release:

Issue key Release description
HAPA-159 Resolved the following critical security vulnerabilities:
  • CVE-2024-38819
  • CVE-2024-10039
  • CVE-2024-50379
  • CVE-2024-56337
  • CVE-2024-3596

API Gateway 2.3.0 Copied

Released: 4 October 2024

New features and enhancements Copied

These are the new features and enhancements of this release:

Issue key Release description
HAPA-143 App workloads now restart if any of their configuration options change via a helm upgrade.
HAPA-156 The seasonal model now takes daylight saving transitions into account when aggregating data.

Legacy releases Copied

API Gateway 2.2.1 Copied

Released: 13 August 2024

New features and enhancements Copied

These are the new features and enhancements of this release:

Issue key Release description
HAPA-144 Upgraded iam-tools to version 2.6.0 to resolve critical CVEs.

API Gateway 2.2.0 Copied

Released: 26 April 2024

New features and enhancements Copied

These are the new features and enhancements of this release:

Issue key Release description
HAPA-93 Added a public API endpoint that returns a seasonal model based on historical metric data. The model consists of a number of metric aggregations such as arbitrary percentiles, variance, and standard deviation and can be configured with a period and granularity that match the pattern and behavior of the underlying metric.
HAPA-98 Added a public API endpoint that supports the retrieval of up to 10 summary statistics for a metric over a time range.

API Gateway 2.1.0 Copied

Released: 23 January 2024

Caution

Before upgrading, you must first uninstall all ITRS Analytics apps. Due to a breaking change in a core library (Spring Boot), you need to upgrade all ITRS Analytics apps at the same time. Make sure that you reinstall the latest mutually compatible versions of ITRS Analytics apps. See the ITRS Analytics Compatibility Matrix.

New features and enhancements Copied

These are the new features and enhancements of this release:

Issue key Release description
HAPA-109 Upgraded Spring Boot to version 3.2.1, which resolves the following reported security vulnerability: BDSA-2023-3298 or CVE-2023-46589.
HAPA-119 The public API no longer issues HTTP requests to all plugins to determine the existence of a REST API. It now uses a different REST API discovery mechanism, which has improved the initial page load time.
HAPA-120 The REST API for the last selected application is now stored in the user’s session and persists when the user returns to the Public API page after navigating to other apps.

Issues fixed Copied

These are the issues we have fixed in this release:

Issue key Release description
HAPA-121 A human readable message is now displayed in REST API responses when the payload is malformed.

API Gateway 2.0.0 Copied

Released: 8 December 2023

New features and enhancements Copied

These are the new features and enhancements of this release:

Issue key Release description
HAPA-47 Remove deprecated GetMetricNames(), GetNames(), and GetValues() functions.
HAPA-73 Upgraded app for compatibility with ITRS Analytics Platform 2.0.

API Gateway 1.3.0 Copied

Released: 28 June 2023

Caution

Before upgrading to API Gateway 1.3.0, you must first uninstall all ITRS Analytics apps. Due to Web Platform security changes, you need to upgrade all ITRS Analytics apps at the same time. Make sure that you reinstall the latest mutually compatible versions of ITRS Analytics apps. See the ITRS Analytics Compatibility Matrix.

New features and enhancements Copied

These are the new features and enhancements of this release:

Issue key Release description
HAPA-62 A security upgrade, migrating from Keycloak Spring Boot Starter to Spring Boot 3.x, has been implemented in the Web Platform. Improved session management also keeps you signed in as long as the browser remains open.

Issues fixed Copied

These are the issues we have fixed in this release:

Issue key Release description
HAPA-52 Fixed an issue to include 0 values in the JSON response.

API Gateway 1.2.0 Copied

Released: 14 April 2023

New features and enhancements Copied

These are the new features and enhancements of this release:

Issue key Release description
HAPA-37 The new GetMetricMetadata(), GetNamesData(), and GetValuesData() endpoints have been added to replace the deprecated GetMetricNames(), GetNames(), and GetValues() endpoints, which will be removed in app version 1.3.0.

Open known issues Copied

These are the known issues affecting this release:

Issue key Known issue description
HAPA-41 A flaw found in Ramda 0.27.0 and earlier, which can lead to prototype poisoning in functions, has been flagged by Black Duck. This can affect the integrity or availability of the application. The reported security vulnerability is: CVE-2021-42581.

API Gateway 1.1.0 Copied

Released: 15 November 2022

New features and enhancements Copied

These are the new features and enhancements of this release:

Issue key Release description
HAPA-36 UI enhancements entailed the following upgraded versions:
  • React Router has been upgraded to version 6.
  • React has been upgraded to version 18.
  • React Testing Library packages have been upgraded.
  • Material UI has been upgraded to version 5.

Disclaimer

The information contained in this document is for general information and guidance on our products, services, and other matters. It is only for information purposes and is not intended as advice which should be relied upon. We try to ensure that the content of this document is accurate and up-to-date, but this cannot be guaranteed. Changes may be made to our products, services, and other matters which are not noted or recorded herein. All liability for loss and damage arising from reliance on this document is excluded (except where death or personal injury arises from our negligence or loss or damage arises from any fraud on our part).
["ITRS Analytics"] ["Release Notes"]

Was this topic helpful?