HealthCheckResponse¶
Example Json Object
1{
2 "healthy": true,
3 "message": "string",
4 "timestamp": "2019-08-24T14:15:22Z",
5 "version": "string",
6 "metrics": {
7 "property1": {},
8 "property2": {}
9 },
10 "issues": [
11 {
12 "id": "string",
13 "severity": "string",
14 "component": "string",
15 "message": "string",
16 "description": "string",
17 "detectedAt": "2019-08-24T14:15:22Z",
18 "metadata": {
19 "property1": {},
20 "property2": {}
21 },
22 "recommendation": "string",
23 "resolved": true,
24 "resolvedAt": "2019-08-24T14:15:22Z"
25 }
26 ],
27 "components": {
28 "property1": {
29 "healthy": true,
30 "status": "string",
31 "message": "string",
32 "details": {
33 "property1": {},
34 "property2": {}
35 },
36 "responseTimeMs": 0
37 },
38 "property2": {
39 "healthy": true,
40 "status": "string",
41 "message": "string",
42 "details": {
43 "property1": {},
44 "property2": {}
45 },
46 "responseTimeMs": 0
47 }
48 }
49}
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
healthy |
boolean |
false |
none |
none |
message |
string |
false |
none |
none |
timestamp |
string(date-time) |
false |
none |
none |
version |
string |
false |
none |
none |
metrics |
object |
false |
none |
none |
» additionalProperties |
object |
false |
none |
none |
issues |
false |
none |
none |
|
components |
object |
false |
none |
none |
» additionalProperties |
false |
none |
none |