Get Server Health API Changed

  • Published on Mar 26, 2025
Prev Next

Breaking Change Notice

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

The response object from this API that is used to return the version and release properties is as follows:

  • version: The version property contained the Build Version of the Platform.
  • release: The release property contained the Release Version of the Platform.

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

  • version: The version property will contain the Release Version of the Platform. This is the version communicated in release materials and documentation.
  • build: The new build property will contain the Build Version which was previously returned by the version property.
  • release: The release property will continue to contain the Release Version, and is now redundant with the version property. The release property has been retained to lessen the breaking nature of this change.

Example response excerpt from the old API version:

{
  "version": "2025.21.0",  
  "release": "6.0.1",
  ...
}

Example response excerpt from the new API version:

{
  "version": "6.0.1",  
  "release": "6.0.1",
  "build": "2025.13.1",
  ...
}

Why make this change?

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

What should I do?

If one of your use cases depends 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.

Note that both the Build Version and Release Version follow semantic versioning, and the difference between the two has only to do with the actual contents of the value.

If you need any additional support or require more information, please reach out to Itential's Product Support Team for assistance.