Release notesBreaking changes

Help and Status API endpoints removed

Breaking change notices

Help API removed

All dynamic and non-dynamic API endpoints within Itential Platform are now fully compliant with OpenAPI 3.0 specifications. The GET /help/api/json endpoint that supported in-app API documentation has been removed and replaced with GET /help/openapi.

ItemDescriptionDeprecation releaseRemoval releaseReplacement
GET /help/api/jsonDisplays the Help UI within the system.2023.12023.2GET /help/openapi

What should I do?

Update all API keys and HTTP/HTTPS clients to use the new help/openapi specification.

Status API removed

The GET /status API has been removed and replaced with /health/status, which reports the health of all apps and adapters.

ItemDescriptionDeprecation releaseRemoval releaseReplacement
GET /statusReports on the status of the system at startup.2023.12023.2GET /health/status

What should I do?

Review any custom apps and adapters that reference the /status API and update them to use /health/status.