System

Service health and readiness check

READ. Liveness by default. With ?ready=true the endpoint also probes the database dependency and returns 200 when ready or 503 when degraded. Exposes status words, booleans and a latency figure only — never hostnames, connection strings, environment values or error details.

get/api/public/v1/health

Request

  • Base URL: https://www.vaheroesph.com
  • URL: https://www.vaheroesph.com/api/public/v1/health
  • Auth: none required

Query parameters

ready'true'

Set to true to run the readiness probe (API + database).

Response

Service is healthy.

status'ok' | 'degraded' required

"ok" when the service is healthy, "degraded" when a dependency is unavailable.

servicestring

Service identifier.

versionstring required

API version identifier.

timestampstring date-time required

Server time of the response.

readyboolean

Readiness result. Present only on the readiness probe.

Changes

No recorded changes to this operation across all 1 revision of this API.