Hub Home Downloads Documentation Releases

Device health

PreviousBeams and presets NextControllers

Last updated 11 months ago

Was this helpful?

Get Health

get

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

Responses

200

application/json

500

Internal server error

application/json

get

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

{
  "arrays": {
    "ANY_ADDITIONAL_PROPERTY": {
      "message": "Okay",
      "status": "okay"
    }
  },
  "controllers": {
    "ANY_ADDITIONAL_PROPERTY": {
      "message": "Okay",
      "status": "okay"
    }
  },
  "modules": {
    "ANY_ADDITIONAL_PROPERTY": {
      "message": "Okay",
      "status": "okay"
    }
  },
  "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

get

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

200

No content