Device health

Get Health

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

get

/status/health

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://AAA-1234.local/psapi/status/health'

200

500

200

{
  "system": {
    "message": "Okay",
    "status": "okay"
  },
  "arrays": {
    "ANY_ADDITIONAL_PROPERTY": {
      "message": "Okay",
      "status": "okay"
    }
  },
  "controllers": {
    "ANY_ADDITIONAL_PROPERTY": {
      "message": "Okay",
      "status": "okay"
    }
  },
  "modules": {
    "ANY_ADDITIONAL_PROPERTY": {
      "message": "Okay",
      "status": "okay"
    }
  }
}

OK

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

get

/ws/status/health

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://AAA-1234.local/psapi/ws/status/health'

200

200

No body

OK