Skip to content

Health Check

Check the operational status of the SIA Checker API and its dependencies. This endpoint is useful for monitoring and health check integrations.

Request

GET https://api.siachecker.co.uk/health

Successful response

200 OK

JSON
{
  "version": "00411df",
  "status": "OK",
  "checks": {
    "database": true
  }
}

Response fields

Field Type Description
version string Current API version or build identifier
status string Overall health status: OK or DEGRADED
checks object Health status of individual dependencies
checks.database boolean Database connectivity status (true = healthy)

Notes

  • This endpoint does not require authentication
  • Use this endpoint for automated health checks and monitoring
  • A 200 OK response indicates the API is operational
  • Individual dependency failures may be reflected in the checks object