---
title: "Health"
method: GET
path: "/health"
---

# Health

`GET /health`

## Request

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

Liveness, and the two facts you need when something looks wrong.

``database`` names the host and database this process is actually connected
to -- host and name only, never credentials. It is here rather than behind
auth because the question it answers ("is prod pointed at the right
database?") is one you ask when you cannot get in, and because the answer
reveals nothing a port scan would not.

Added after production spent five hours on a stale database with a perfectly
healthy ``/health``.

## Response `200`

Successful Response

- object

---

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