System

Get health status

Check whether Blnk Core is running and reachable with the TypeScript SDK.

GET/health

Use blnk.System.health to check whether Core is reachable.

Call the method

const response = await blnk.System.health();

This method takes no arguments.

Confirm Core is healthy

Check that response.data.status is UP before running other SDK calls in health checks or startup probes.

Response

{
  "status": "UP"
}
FieldTypeDescription
statusstringUP when Core is healthy and reachable.