Health check

​

Authorization

If set, the API uses an API key for authentication. Include the following header in your requests: X-blnk-key: <api-key>.

Replace <api-key> with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code.

See also: Secure your Blnk server

​

Overview

The Health Check endpoint allows you to verify that your Blnk API server is running and responsive. It is typically used for readiness and liveness checks in deployment environments (e.g., Docker, Kubernetes, load balancers).

curl --request GET \
  --url http://localhost:5001/health

{
  "status": "UP"
}

​

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.