Skip to Content
🎉 New release with new features and improvements! V0.0.6 Release →

Status API

Public health and setup checks for your engine instance.

Base Endpoint

/api/status

These routes are public (no authentication required). The HTML dashboard also exposes a /status view for operators.

Endpoints

MethodEndpointDescription
GET/api/statusFull engine status payload (configuration sanity, version, etc.)
GET/api/status/healthLightweight health check

Example

curl https://your-instance.com/api/status/health

SDK

await bshEngine.status.health(); await bshEngine.status.load();

See Status service.