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.

Responses

200

The box is up.

application/json

object

required

boolean

startedAt

required

When the box service started.

string format: date-time

resumed

required

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

Array<string>

tasks

required

How many tasks the log holds.

integer

tools

required

Every installed tool name.

Array<string>

spacetime

required

object

port

required

integer

database

required

string

Example

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

GurtOS is open source under the Apache License 2.0.Source code on GitHub.