Device health

Get Health

get

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

Responses

200

OK

application/json

500

Internal server error

application/json

get

/status/health

HTTPcURLJavaScriptPython

GET /psapi/status/health HTTP/1.1
Host: ABC-1234.local
Accept: */*

{
  "arrays": {
    "ANY_ADDITIONAL_PROPERTY": {
      "message": "Okay",
      "status": "okay"
    }
  },
  "controllers": {
    "ANY_ADDITIONAL_PROPERTY": {
      "hardware_status": "okay",
      "message": "Okay",
      "network_status": "okay",
      "status": "okay"
    }
  },
  "modules": {
    "ANY_ADDITIONAL_PROPERTY": {
      "hardware_status": "okay",
      "message": "Okay",
      "network_status": "okay",
      "status": "okay"
    }
  },
  "processors": {
    "ANY_ADDITIONAL_PROPERTY": {
      "health": {
        "hardware_status": "okay",
        "message": "Okay",
        "network_status": "okay",
        "software_status": "okay",
        "status": "okay"
      },
      "pairing": "123e4567-e89b-12d3-a456-426614174000"
    }
  },
  "system": {
    "message": "Okay",
    "status": "okay"
  }
}

Stream System Health

get

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()));

Responses

200

OK

No content

get

/ws/status/health

HTTPcURLJavaScriptPython

GET /psapi/ws/status/health HTTP/1.1
Host: ABC-1234.local
Accept: */*

200

OK

No content