---
title: "Get health of API"
method: GET
path: "/health"
tags: ["Public"]
---

# Get health of API

`GET /health`

Returns a health information of API and list of the health of its dependent services

## Response `200`

Health information and list of dependent services health

- Health
  - `status` 'OK' | 'WARNING' | 'CRITICAL' — The status of the API
  - `version` object
    - `build_time` string — The build date and time of the API
    - `git_commit` string — The git commit hash of the API
    - `language` string — The programming language used to implement API
    - `language_version` string — The version of the programming language used to implement API
    - `version` string — The version of API
  - `uptime` string — The uptime of API
  - `start_time` string — The start date and time of API running
  - `checks` HealthChecker[]
    - `name` 'mongodb' — The name of external service used by API
    - `status` 'OK' | 'WARNING' | 'CRITICAL' — The status of the external service
    - `message` string — The message status of the external service
    - `last_checked` string — The last health check date and time of the external service
    - `last_success` string — The last successful health check date and time of the external service
    - `last_failure` string — The last failed health check date and time of the external service

## Other responses

- `500` — Failed to process the request due to an internal error

---

[API](https://skmtc.net/office-of-national-statistics/apis/recipe-api.md) · [All operations](https://skmtc.net/office-of-national-statistics/apis/recipe-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/office-of-national-statistics/recipe-api/revisions/51dcd3258b3d/schema)