System

Get health status

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

GET/health

Use client.Health.Check to check whether Core is reachable.

Call the method

health, _, _ := client.Health.Check()

This method takes no arguments.

Confirm Core is healthy

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

Response

{
  "status": "UP"
}

Go response (*blnkgo.HealthResponse)

FieldTypeDescription
StatusstringUP when Core is healthy and reachable.
ReasonstringOptional detail when Core reports an unhealthy state.