| GET | /healthchecks/hc | Reaquest API's helth check. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DBTimeout | query | int? | No | |
| CacheTimeout | query | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| HealthChecks | form | List<HealthCheckResult> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | form | ApiResponseStatus | No | |
| Code | form | int | No | |
| apiVersion | form | string | No | |
| appVersion | form | string | No |
| OK | |
| FAIL | |
| Default |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CheckStatus | form | CheckStatus | No | |
| CheckStatusCode | form | string | No | |
| Description | form | string | No | |
| ElapsedMs | form | long | No |
| Unknown | |
| Unhealthy | |
| Healthy | |
| Warning |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /healthchecks/hc HTTP/1.1 Host: auth.mepis.si Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
healthChecks:
[
{
checkStatus: Unknown,
checkStatusCode: Unknown,
description: String,
elapsedMs: 0
}
],
status: OK,
code: 0,
apiVersion: String,
appVersion: String
}