Device health

Get Health

Get health information for the system, all controllers and all modules

GEThttp://AAA-1234.local/psapi/status/health

Response

200500

OK

Body

application/json

arraysobject

controllersobject

modulesobject

systemapi.SystemHealth (object)

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/status/health', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "system": {
    "message": "Okay",
    "status": "okay"
  }
}

Stream System Health

This endpoint can be used to stream system health status information through WebSockets. The payload returned is the same as in GET /status/health but only the fields that have changed will be populated.

Upon reception of a message through the WebSocket, a full system status can be retrieved by issuing a GET request to /status/health.

Find a Javascript client to use use this endpoint below.

const WebSocket = require('ws');

const client = new WebSocket('ws://localhost:6789/ws/status/health');
client.on('message', msg => console.log("Health status update:" + msg.toString()));

GEThttp://AAA-1234.local/psapi/ws/status/health

Response

200

OK

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/ws/status/health', {
    method: 'GET',
    headers: {},
});
const data = await response.json();