System Health
The Atlas Core API can help you manage the health of your system
Sensors
If your Atlas system is a physical system, we can get information from the sensors for you.
View System Sensors
Call to /system/health/sensors to view system sensor information
Request Object
+ URL
/api/v2/system/health/sensors
+ Method
GET
+ Headers
Content-Type: application/json
token: ThisIsNotARealTokenGenerateYourOwnToken
+ Body
{}
Response Object
This will return to you a list of system sensor information
+ Headers
X-Powered-By: OpenDrives
Access-Control-Allow-Origin: *
Content-Type: application/json; charset=utf-8
+ Body
[
{
"name": "CPU1 Temp",
"data": "35.000",
"units": "degrees C",
"status": "ok",
"lower_non_recoverable": "0.000",
"lower_critical": "0.000",
"lower_non_critical": "0.000",
"upper_non_critical": "92.000",
"upper_critical": "95.000",
"upper_non_recoverable": "97.000"
},
{
"name": "CPU2 Temp",
"data": "39.000",
"units": "degrees C",
"status": "ok",
"lower_non_recoverable": "0.000",
"lower_critical": "0.000",
"lower_non_critical": "0.000",
"upper_non_critical": "92.000",
"upper_critical": "95.000",
"upper_non_recoverable": "97.000"
},
{
"name": "System Temp",
"data": "32.000",
"units": "degrees C",
"status": "ok",
"lower_non_recoverable": "-9.000",
"lower_critical": "-7.000",
"lower_non_critical": "-5.000",
"upper_non_critical": "80.000",
"upper_critical": "85.000",
"upper_non_recoverable": "90.000"
},
{
"name": "Peripheral Temp",
"data": "-40.000",
"units": "degrees C",
"status": "nr",
"lower_non_recoverable": "-9.000",
"lower_critical": "-7.000",
"lower_non_critical": "-5.000",
"upper_non_critical": "80.000",
"upper_critical": "85.000",
"upper_non_recoverable": "90.000"
},
{
"name": "GPU1 Temp",
"data": "na",
"units": "",
"status": "na",
"lower_non_recoverable": "na",
"lower_critical": "na",
"lower_non_critical": "na",
"upper_non_critical": "na",
"upper_critical": "na",
"upper_non_recoverable": "na"
},
{
"name": "GPU2 Temp",
"data": "na",
"units": "",
"status": "na",
"lower_non_recoverable": "na",
"lower_critical": "na",
"lower_non_critical": "na",
"upper_non_critical": "na",
"upper_critical": "na",
"upper_non_recoverable": "na"
},
{
"name": "FAN1",
"data": "7275.000",
"units": "RPM",
"status": "ok",
"lower_non_recoverable": "300.000",
"lower_critical": "450.000",
"lower_non_critical": "600.000",
"upper_non_critical": "18975.000",
"upper_critical": "19050.000",
"upper_non_recoverable": "19125.000"
},
{
"name": "VTT",
"data": "1.008",
"units": "Volts",
"status": "ok",
"lower_non_recoverable": "0.816",
"lower_critical": "0.864",
"lower_non_critical": "0.912",
"upper_non_critical": "1.344",
"upper_critical": "1.392",
"upper_non_recoverable": "1.440"
},
{
"name": "5V",
"data": "4.992",
"units": "Volts",
"status": "ok",
"lower_non_recoverable": "4.096",
"lower_critical": "4.288",
"lower_non_critical": "4.480",
"upper_non_critical": "5.504",
"upper_critical": "5.696",
"upper_non_recoverable": "6.912"
},
{
"name": "+5VSB",
"data": "4.928",
"units": "Volts",
"status": "ok",
"lower_non_recoverable": "4.096",
"lower_critical": "4.288",
"lower_non_critical": "4.480",
"upper_non_critical": "5.504",
"upper_critical": "5.696",
"upper_non_recoverable": "6.912"
},
{
"name": "Chassis Intru",
"data": "0x1",
"units": "discrete",
"status": "0x0100",
"lower_non_recoverable": "na",
"lower_critical": "na",
"lower_non_critical": "na",
"upper_non_critical": "na",
"upper_critical": "na",
"upper_non_recoverable": "na"
},
{
"name": "PS1 Status",
"data": "0x1",
"units": "discrete",
"status": "0x0100",
"lower_non_recoverable": "na",
"lower_critical": "na",
"lower_non_critical": "na",
"upper_non_critical": "na",
"upper_critical": "na",
"upper_non_recoverable": "na"
},
{
"name": "PS2 Status",
"data": "0x1",
"units": "discrete",
"status": "0x0100",
"lower_non_recoverable": "na",
"lower_critical": "na",
"lower_non_critical": "na",
"upper_non_critical": "na",
"upper_critical": "na",
"upper_non_recoverable": "na"
}
]
Events
If your Atlas system is a physical system, we can get system event information for you.
View System Events
Call to /system/health/events to view system event information
Request Object
+ URL
/api/v2/system/health/events
+ Method
GET
+ Headers
Content-Type: application/json
token: ThisIsNotARealTokenGenerateYourOwnToken
+ Body
{}
Response Object
This request returns a list of system events.
+ Headers
X-Powered-By: OpenDrives
Access-Control-Allow-Origin: *
Content-Type: application/json; charset=utf-8
+ Body
[
{
"date": "03/29/2019",
"time": "23:01:36",
"sensor": "Power Supply #0xc9",
"description": "Failure detected ()",
"assert": "Deasserted"
},
{
"date": "08/09/2020",
"time": "20:08:31",
"sensor": "Physical Security #0x51",
"description": "General Chassis intrusion ()",
"assert": "Asserted"
},
{
"date": "09/17/2020",
"time": "12:32:42",
"sensor": "Unknown #0xff",
"description": "",
"assert": "Asserted"
},
{
"date": "09/17/2020",
"time": "17:32:01",
"sensor": "Physical Security #0x51",
"description": "General Chassis intrusion ()",
"assert": "Asserted"
}
]
System Health Reports
Each Atlas system comes with the ability to generate a report of its current health. These are the System Quality, Usage, And Network Current Health reports.
View Available Reports
Call to /system/health/report to view available system health reports
Request Object
+ URL
/api/v2/system/health/report
+ Method
GET
+ Headers
Content-Type: application/json
token: ThisIsNotARealTokenGenerateYourOwnToken
+ Body
{}
Response Object
This request returns a list of system reports.
+ Headers
X-Powered-By: OpenDrives
Access-Control-Allow-Origin: *
Content-Type: application/json; charset=utf-8
+ Body
[
{
"name": "squanch_hostname__2022-11-10__11-48.tar.gz",
"dev": 37,
"mode": 33188,
"nlink": 1,
"uid": 0,
"gid": 0,
"rdev": 0,
"blksize": 131072,
"ino": 184652,
"size": 10865680,
"blocks": 20481,
"atimeMs": 1668109725556.44,
"mtimeMs": 1668109725904.4429,
"ctimeMs": 1668109725904.4429,
"birthtimeMs": 1668109725556.44,
"atime": "2022-11-10T19:48:45.556Z",
"mtime": "2022-11-10T19:48:45.904Z",
"ctime": "2022-11-10T19:48:45.904Z",
"birthtime": "2022-11-10T19:48:45.556Z"
},
{
"name": "squanch_hostname__2022-11-10__11-55.tar.gz",
"dev": 37,
"mode": 33188,
"nlink": 1,
"uid": 0,
"gid": 0,
"rdev": 0,
"blksize": 131072,
"ino": 184785,
"size": 10882064,
"blocks": 20505,
"atimeMs": 1668110124547.7214,
"mtimeMs": 1668110124891.724,
"ctimeMs": 1668110124891.724,
"birthtimeMs": 1668110124547.7214,
"atime": "2022-11-10T19:55:24.548Z",
"mtime": "2022-11-10T19:55:24.892Z",
"ctime": "2022-11-10T19:55:24.892Z",
"birthtime": "2022-11-10T19:55:24.548Z"
}
]
Download a Report
Downloading a report is a bit different than other calls, as it will return a file stream instead of JSON.
Request Object
+ URL
/api/v2/system/health/report/download
+ Method
POST
+ Parameters
name (string, required, Body) - this is the report name with the extension '.tar' or 'tar.gz'
+ Headers
Content-Type: application/json
responseType: blob
token: ThisIsNotARealTokenGenerateYourOwnToken
+ Body
{
"name": "squanch_misha-A-2__2023-05-23__08-24.tar.gz"
}
Create a Report
You may create a report at any time, but please note that it is somewhat system taxing, as we are gathering information from many parts of your system.