Check the API is up

health.check

GET/api/v1/health

Returns ok. Public, so monitors can call it.

Response#

200 The API is up.

Check the API is up: response fields
Field	Description
`ok`one of: truerequired	Always true.

Every error has the same envelope: error.code, error.message, error.details, error.recovery and error.request_id.

Check the API is up: errors
Status	Code	When

These are real. Each was recorded from a sample household, the Okafors, running through the whole API when this site was built.

Request, curl

curl 'https://rigel.house/api/v1/health'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/health");
const data = await response.json();

Request, HTTP

GET /api/v1/health HTTP/1.1
Host: rigel.house

Response, 200

HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01M6V9CS5S9YAMFRXRM7R4H7N3

{
  "ok": true
}