Reference - IOM REST API - Health Service 1.0


Product Version

2.13

Product To Version


Status

final

Download Specification 

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

Basic Authentication

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

Restrict Interface Access

It is hardly 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 user name and password.

Authorization

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

Permission required

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

References

API Specification

Introduction

OpenAPI Version: 3.0.1
IOM Health Service REST API Version: 1.0

The API offers server health check service operations.

IOM - Application Monitoring API

GET
/health/clusterstatus Returns the status of all app-servers of a cluster.

Request Path

/health/clusterstatus

Description

Returns the status of all app-servers of a cluster.

Request Body

--

Request Parameters

--

Response

200 - OK

The request succeeded.
Array of HealthCheckStatus application/json[
HealthCheckStatus: Represents the current health status of an app-server.
{
  • "services":
    array
    An array of HealthCheckServiceStatus objects. A list of all services and their status that were checked. | Example: ...
    [
    HealthCheckServiceStatus: Represents the current health status of one service of an app-server.
    {
    • "name":
      string
      Name of the checked service. | Example: database
    • "checked":
      boolean
      Whether the service was checked or not. | Example: true
    • "statusCode":
      integer
      The status code of the checked service. | Format: int32 | Example: 200
    • "description":
      string
      The description of the current status. | Example: OK
    }
    ]
  • "serverId":
    string
    Name of the app-server. | Example: ...
  • "serverType":
    string
    Type of the app-server. | Example: backend
  • "statusCode":
    integer
    The status of the health check. | Format: int32 | Example: 200
  • "description":
    string
    The description of the current status. | Example: OK
  • "lastCheckEpoch":
    integer
    The timestamp as epoch the check was processed. | Format: int64
  • "lastSuccessfulCheckEpoch":
    integer
    The timestamp as epoch the last successful check was processed. | Format: int64
  • "lastCheck":
    string
    The timestamp the check was processed. | Format: date-time
  • "lastSuccessfulCheck":
    string
    The timestamp the last successful check was processed. | Format: date-time
}
]

401 - Unauthorized

403 - Forbidden

500 - Internal Server Error

.
GET
/health/status Checks if the app-server is alive.

Request Path

/health/status

Description

Checks if the app-server is alive.

Request Body

--

Request Parameters

--

Response

200 - OK

The request succeeded.
HealthCheckStatus application/json{
  • "services":
    array
    An array of HealthCheckServiceStatus objects. A list of all services and their status that were checked. | Example: ...
    [
    HealthCheckServiceStatus: Represents the current health status of one service of an app-server.
    {
    • "name":
      string
      Name of the checked service. | Example: database
    • "checked":
      boolean
      Whether the service was checked or not. | Example: true
    • "statusCode":
      integer
      The status code of the checked service. | Format: int32 | Example: 200
    • "description":
      string
      The description of the current status. | Example: OK
    }
    ]
  • "serverId":
    string
    Name of the app-server. | Example: ...
  • "serverType":
    string
    Type of the app-server. | Example: backend
  • "statusCode":
    integer
    The status of the health check. | Format: int32 | Example: 200
  • "description":
    string
    The description of the current status. | Example: OK
  • "lastCheckEpoch":
    integer
    The timestamp as epoch the check was processed. | Format: int64
  • "lastSuccessfulCheckEpoch":
    integer
    The timestamp as epoch the last successful check was processed. | Format: int64
  • "lastCheck":
    string
    The timestamp the check was processed. | Format: date-time
  • "lastSuccessfulCheck":
    string
    The timestamp the last successful check was processed. | Format: date-time
}

500 - Internal Server Error

503 - Service Unavailable

, possibly starting.

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.

Customer Support
Knowledge Base
Product Resources
Support Tickets