IOM Health Service REST API (1.0)

Download OpenAPI specification:Download

The API offers server health check service operations.

Authentication

basicAuth

Basic Authentication

Security Scheme Type	HTTP
HTTP Authorization Scheme	basic

IOM - Application Monitoring

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

Authorizations:

Responses

200

The request succeeded.

401

Unauthorized

403

Forbidden

500

Internal server error.

get /health/clusterstatus

{protocol}://{domain}:{port}/monitoring/services/health/clusterstatus

Response samples

Content type

application/json

Copy

Expand all Collapse all


[
{"services": "...",
"serverId": "...",
"serverType": "backend",
"statusCode": 200,
"description": "OK",
"lastCheckEpoch": 0,
"lastSuccessfulCheckEpoch": 0,
"lastCheck": "2020-04-16T16:12:28Z",
"lastSuccessfulCheck": "2020-04-16T16:12:28Z"
}
]

Checks if the app-server is alive.

Responses

200

The request succeeded.

500

Internal server error

503

Service unavailable, possibly starting.

get /health/status

{protocol}://{domain}:{port}/monitoring/services/health/status

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"services": "...",
"serverId": "...",
"serverType": "backend",
"statusCode": 200,
"description": "OK",
"lastCheckEpoch": 0,
"lastSuccessfulCheckEpoch": 0,
"lastCheck": "2020-04-16T16:12:28Z",
"lastSuccessfulCheck": "2020-04-16T16:12:28Z"
}