---
title: "Returns API's health status"
method: GET
path: "/health"
tags: ["Private"]
---

# Returns API's health status

`GET /health`

Returns health status of the API and checks on dependent services

## Response `200`

Successfully returns OK status with checks of dependent services

- 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

- `429` — Services warming up or degraded (at least one check in WARNING or CRITICAL status)
- `500` — Service is failing having at least one check with a CRITICAL status having exceeded the recovery grace period.

---

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