.png?sv=2022-11-02&spr=https&st=2024-11-23T01%3A15%3A53Z&se=2024-11-23T01%3A25%3A53Z&sr=c&sp=r&sig=tsZgOAZbmoKgQNK%2FkSimcldxY5kEOArTjw%2FIxesJXeo%3D){kind=logo}
Help and Status API Endpoints Removed
- 11 Apr 2024
-
DarkLight
-
PDF
Help and Status API Endpoints Removed
- Updated on 11 Apr 2024
-
DarkLight
-
PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Breaking Change Notices
The following are breaking changes in the 2023.2 IAP release.
Itential policy is to notify customers of deprecations two (2) release cycles in advance (at a minimum) before the API is removed.
Help API Removed Due to Scheduled Deprecation
All dynamic and non-dynamic API endpoints within the Itential platform are now fully compliant with OpenAPI 3.0 specifications. This impacts all API documentation that is rendered through the help interface (Help UI) that displays when users click the Help link within IAP.
The help/api/json that supports the API documentation in-app (i.e., within the Itential application) is removed from IAP in the 2023.2 release and replaced with help/openapi.
| Item | Description | Deprecation Release | Scheduled Removal Release | Replacement |
|---|---|---|---|---|
| GET /help/api/json | Displays the Help UI within the system. | 2023.1 | 2023.2 | GET /help/openapi |
What should I do?
Please update all API keys and HTTP/HTTPS clients to use the new help/openapi specification.
Status API Removed Due to Scheduled Deprecation
The GET /status API is removed from IAP in the 2023.2 release and replaced with the /health/status API that reports the health of all apps and adapters.
| Item | Description | Deprecation Release | Actual Removal Release | Replacement |
|---|---|---|---|---|
| GET /status | Reports on the status of the system at startup. | 2023.1 | 2023.2 | GET /health/status |
What should I do?
Review any custom apps and adapters that might reference the /status API and change them to the new /health/status replacement call.
Was this article helpful?
