---
title: "getHealth"
method: GET
path: "/health"
tags: ["getHealth"]
---

# getHealth

`GET /health`

## Request

- Base URL: `/v2` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/v2/health`
- Auth: none declared
- TypeScript: <https://skmtc.dev/mojaloop/apis/mojaloop-central-settlements/docs/health/get.ts> (a function with typed inputs; its response is checked against the schema)

Gets the health of the service and sub-services (i.e. database).

## Response `200`

A valid and health service.

## Other responses

- `502`: API is live, but error connecting to required sub-service.

---

[API](https://skmtc.dev/mojaloop/apis/mojaloop-central-settlements.md) - [All operations](https://skmtc.dev/mojaloop/apis/mojaloop-central-settlements/llms.txt) - [OpenAPI document](https://skmtc.dev/mojaloop/apis/mojaloop-central-settlements/revisions/7fbaa3e7ca2b?raw)
