mirror of https://github.com/Unleash/unleash.git synced 2025-06-14 01:16:17 +02:00

Gastón Fournier e754212a39

docs: explain health API properly (#10009 )

## About the changes
Our health implementation always returns GOOD if the server is up:
beb29f5b5b/src/lib/routes/health-check.ts (L46-L51)

Currently our documentation of the endpoint is misleading saying that it
will return BAD if unable to connect to PostgreSQL

Closes #9965

2025-05-16 12:38:27 +02:00

344 B

Raw Blame History

title
/health

Health API

GET http://unleash.host.com/health

Used to check the health of the running Unleash instance. This endpoint has two possible responses:

Status: 200

{
  "health": "GOOD"
}

This response means Unleash server is up.

Status: 500

This response indicates that Unleash server is unhealthy.

344 B Raw Blame History

Health API

344 B

Raw Blame History