Reference - IOM REST API - Health Service 1.0

This API specification is available for download as an Open API 3.0 YAML file:

intershop-order-management-monitoring-1.0.yaml

The endpoint health/clusterstatus is deprecated since IOM 4.6.0 and will be removed timely.

Authentication

Basic Authentication

For the server health check there is currently no authorization required.

Restrict Interface Access

It is strongly recommended to allow the access to the service only for server monitoring applications.

To retrieve the clusterstatus, please configure your clients to use this authentication method to submit the user name and password.

Authorization

To retrieve the clusterstatus for a UI-client, use basic authorization and just type in the login and password.

Permission required

For all actions the permission Basic application management is required assigned at root organization OmsSystem.

References

API Specification

Open ReDoc-rendered Open API documentation in separate window.

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.