Check health
Nothing about capacity or load.
GET
/healthzRequest
| Method and path | GET/healthz |
|---|---|
| Base URL | https://api.boxline.dev |
| Authentication | None. Anyone can call it. |
curl "https://api.boxline.dev/healthz"import { Boxline } from "@boxline/sdk";const bx = new Boxline(); // reads BOXLINE_API_KEY and BOXLINE_API_URLconsole.log(await bx.health()); // { ok: true }from boxline import Boxlinebx = Boxline() # reads BOXLINE_API_KEY and BOXLINE_API_URLprint(bx.health()) # {'ok': True}Responses
200 OK
The API is up.
Fields
| Name | Type | Default | Allowed values | Description |
|---|---|---|---|---|
ok | boolean | – | true |
{ "ok": true}These docs describe a beta API. Endpoints, fields and SDK methods may change before general availability; breaking changes will be listed in the changelog.