API Reference

Health

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Health check

get/health

Health check

ReturnsExpand Collapse

status: "ok"

Accepts one of the following:

"ok"

Health check

HTTP

HTTP

Go

curl http://localhost:8080/health \
    -H "Authorization: Bearer $HYPEMAN_API_KEY"

200 example

{
  "status": "ok"
}

Returns Examples

200 example

{
  "status": "ok"
}