---
title: "Service health and readiness check"
method: GET
path: "/api/public/v1/health"
tags: ["System"]
---

# Service health and readiness check

`GET /api/public/v1/health`

## Request

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

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.

## Query parameters

- `ready` 'true'

## Response `200`

Service is healthy.

- Health: API liveness information. With ?ready=true the response also reports readiness of the API and its database dependency, as booleans and status words only — never infrastructure details.
  - `status` 'ok' | 'degraded', required: "ok" when the service is healthy, "degraded" when a dependency is unavailable.
  - `service` string: Service identifier.
  - `version` string, required: API version identifier.
  - `timestamp` string, date-time, required: Server time of the response.
  - `ready` boolean: Readiness result. Present only on the readiness probe.
  - `checks` object: Dependency results. Present only on the readiness probe.
    - `api` 'ok', required: Request pipeline is serving.
    - `database` 'ok' | 'unavailable', required: Database reachability. No hostnames, credentials or error details.
    - `databaseLatencyMs` integer: Round-trip duration of the database probe.

## Other responses

- `500`: Unexpected server error.
- `503`: A dependency is unavailable; the service is degraded.

---

[API](https://skmtc.dev/vaheroesph/apis/va-heroes-ph-public-content-api.md) · [All operations](https://skmtc.dev/vaheroesph/apis/va-heroes-ph-public-content-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vaheroesph/apis/va-heroes-ph-public-content-api/revisions/65ddf4d10897?raw)