List Health Configurations
The following example shows how to get a list of all health configurations for your account.
Request
/ws/v1/health_configs/inventory
Response
Note Because each device health configuration applies to a single device type and itself, defines many rules and thresholds for multiple health metrics, the full output is not shown here. To see the full output, go to Documentation > API Explorer and send the v1/health_configs/List all health configs to see details for all health configurations and corresponding metrics on your system.
{
"count": 8,
"list": [
{
"customer_id": 57639,
"enabled": true,
"id": "FE00000A/DIGI TX64",
"last_modified": "2022-04-06T23:21:23.246Z",
"rules": [
{
"categories": [
"Device"
],
"description": "Internal temperature of system CPU core (Celsius) during the sample period",
"enabled": true,
"name": "Temperature (Core)",
"stream": "DataPoint/*/metrics/sys/core_temperature",
"threshold": {
"error": {
"ranges": [
{
"lower": 70,
"lower_bound_type": "CLOSED",
"upper_bound_type": "CLOSED"
}
]
},
"normal": {
"ranges": [
{
"lower_bound_type": "CLOSED",
"upper": 60,
"upper_bound_type": "CLOSED"
}
]
},
"warning": {
"ranges": [
{
"lower": 60,
"lower_bound_type": "OPEN",
"upper": 70,
"upper_bound_type": "OPEN"
}
]
}
},
"type": "FLOAT",
"units": "Celsius"
},
{
"categories": [
"Device"
],
"description": "Percentage of CPU used during the sample period",
"enabled": true,
"name": "CPU used",
"stream": "DataPoint/*/metrics/sys/cpu/used",
"threshold": {
"error": {
"ranges": [
{
"lower": 95,
"lower_bound_type": "CLOSED",
"upper_bound_type": "CLOSED"
}
]
},
"normal": {
"ranges": [
{
"lower_bound_type": "CLOSED",
"upper": 90,
"upper_bound_type": "CLOSED"
}
]
},
"warning": {
"ranges": [
{
"lower": 90,
"lower_bound_type": "OPEN",
"upper": 95,
"upper_bound_type": "OPEN"
}
]
}
},
"type": "FLOAT",
"units": "%"
},
{
"categories": [
"Device"
],
"description": "Percentage of memory used during the sample period",
"enabled": true,
"name": "Memory used",
"stream": "DataPoint/*/metrics/sys/mem/used",
"threshold": {
"error": {
"ranges": [
{
"lower": 95,
"lower_bound_type": "CLOSED",
"upper_bound_type": "CLOSED"
}
]
},
"normal": {
"ranges": [
{
"lower_bound_type": "CLOSED",
"upper": 90,
"upper_bound_type": "CLOSED"
}
]
},
"warning": {
"ranges": [
{
"lower": 90,
"lower_bound_type": "OPEN",
"upper": 95,
"upper_bound_type": "OPEN"
}
]
}
},
"type": "FLOAT",
"units": "%"
}
...etc..
]
},
...etc...
],
"size": 1000
}