---
title: "Health / readiness probe"
method: GET
path: "/v1/awe/health"
tags: ["health"]
---

# Health / readiness probe

`GET /v1/awe/health`

## Response `200`

Service is ready.

- HealthResponse
  - `id` string
  - `version` string
  - `responsetime` string, required
  - `response` HealthPayload, required
    - `status` string, required
  - `errors` ErrorDetail[]
    - `errorCode` string, required — OpenG2P-assigned error code. AWE catalog: `AWE-001` (policy not found), `AWE-002` (policy conflict / version clash), `AWE-003` (request not found), `AWE-004` (task not found), `AWE-005` (service not ready — startup incomplete), `AWE-006` (database health check failed), `AWE-007` (invalid state transition), `AWE-008` (unauthorized / forbidden), `AWE-009` (idempotency key conflict with different payload), `AWE-010` (validation — bad policy definition).
    - `message` string, required

## Other responses

- `503` — Health probe failed to reach the database.

---

[API](https://skmtc.net/openg2p/apis/openg2p-registry-beneficiary-portal-api.md) · [All operations](https://skmtc.net/openg2p/apis/openg2p-registry-beneficiary-portal-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openg2p/openg2p-registry-beneficiary-portal-api/revisions/557f1a1d4145/schema)