---
title: "Get shallow, deep, storage, or PostgreSQL health."
method: GET
path: "/api/health"
tags: ["Health"]
---

# Get shallow, deep, storage, or PostgreSQL health.

`GET /api/health`

## Request

- Base URL: `https://commentary.dev`
- URL: `https://commentary.dev/api/health`
- Auth: none declared

## Query parameters

- `check` 'postgres' | 'storage' | 'deep'

## Response `200`

Successful response.

- object

## Other responses

- `503`: Health check failed.

---

[API](https://skmtc.dev/commentary/apis/commentary-public-api.md) · [All operations](https://skmtc.dev/commentary/apis/commentary-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/commentary/apis/commentary-public-api/revisions/7aaafc198c52?raw)