Check the box service

GET

/health

const url = 'http://127.0.0.1:7700/api/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://127.0.0.1:7700/api/health

Answers once the box has replayed its log, loaded its apps and opened the API. The OS image’s update check waits for ok here before it keeps a new system. Without a token, from outside the box, the answer is only ok, startedAt and paused. From the box’s own screen, or with a device token, it also holds the rest.

Responses

200

The box is up.

application/json

object

required

boolean

startedAt

required

When the box service started.

string format: date-time

paused

required

Whether the kill switch is on.

boolean

cleanStart

Not in the short answer. Whether the last stop was clean. False after a power cut.

boolean

resumed

Not in the short answer. Tasks the box restarted at boot because they were still going when it went down.

Array<string>

tasks

Not in the short answer. How many tasks the log holds.

integer

tools

Not in the short answer. Every installed tool name.

Array<string>

spacetime

Not in the short answer.

object

port

required

integer

database

required

string

Examples

From the box or with a device token

{
  "ok": true,
  "startedAt": "2026-10-24T09:00:01.210Z",
  "paused": false,
  "cleanStart": true,
  "resumed": [
    "t3k9x2a1b2"
  ],
  "tasks": 12,
  "tools": [
    "example.spend"
  ],
  "spacetime": {
    "port": 3000,
    "database": "box"
  }
}

With no token, from outside

{
  "ok": true,
  "startedAt": "2026-10-24T09:00:01.210Z",
  "paused": false
}