Health check

GET

/v1/sys/health

const url = 'http://localhost:8693/v1/sys/health';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8693/v1/sys/health

Returns the health status of the Starfly unit.

Responses

200

Healthy

application/json

object

initialized

required

boolean

locked

required

boolean

version

required

string

unit_id

required

string

Example

{
  "initialized": true,
  "locked": false,
  "version": "1.0.0",
  "unit_id": "abc123def456"
}