Get Server Health API changed

The getServerHealth API, corresponding to the HTTP route GET /health/server, has been changed to more accurately reflect the new release versioning practices adopted with Platform 6.

What changed

The response object previously returned version and release properties as follows:

  • version — The Build Version of the Platform.
  • release — The Release Version of the Platform.

After this change, the version, release, and new build properties are returned as follows:

  • version — The Release Version of the Platform. This is the version communicated in release materials and documentation.
  • build — The Build Version, which was previously returned by the version property.
  • release — The Release Version, now redundant with version. Retained to lessen the breaking nature of this change.

Old response:

1{
2 "version": "2025.21.0",
3 "release": "6.0.1"
4}

New response:

1{
2 "version": "6.0.1",
3 "release": "6.0.1",
4 "build": "2025.13.1"
5}

Why this change was made

This change better aligns Itential Platform with the versioning communicated to customers. Platform now identifies its own version accurately as the Release Version presented to users in marketing materials and documentation.

What should I do?

If any of your use cases depend on the exact versioning pattern previously returned by the version field of getServerHealth, update that use case to use the new build field, or to operate in terms of the Release Version now returned by version.

Both the Build Version and Release Version follow semantic versioning. The difference between the two is only the actual content of the value.

If you need additional support or require more information, contact the Product Support Team.