---
title: "Perform a Health Check"
method: GET
path: "/healthz"
tags: ["healthcheck"]
---

# Perform a Health Check

`GET /healthz`

## Request

- Base URL: `https://api.mentium.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.mentium.io/healthz`
- Auth: none declared

## Perform a Health Check
Endpoint to perform a healthcheck on. This endpoint can primarily be used Docker
to ensure a robust container orchestration and management is in place. Other
services which rely on proper functioning of the API service will not deploy if this
endpoint returns any other HTTP status code except 200 (OK).
Returns:
    HealthCheck: Returns a JSON response with the health status

## Response `200`

Return HTTP Status Code 200 (OK)

- HealthCheck: Response model to validate and return when performing a health check.
  - `status` string

---

[API](https://skmtc.dev/mentium/apis/mentium-api.md) - [All operations](https://skmtc.dev/mentium/apis/mentium-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mentium/apis/mentium-api/revisions/b4ed8e59432e?raw)