Skip to main content
GET
/
health
Get health status
curl --request GET \
  --url http://localhost:5001/health \
  --header 'X-blnk-key: <api-key>'
Use blnk.System.health to check whether Core is reachable.
blnk.System.health
const response = await blnk.System.health();
This method takes no arguments.

Response shape

200 OK
{
  "status": "UP"
}
FieldDescription
statusUP when Core is healthy and reachable.

Set up the SDK

Initialize the client and configure the base URL.

Health check

HTTP request and response schema.

Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.