View .md

Health endpoints (System (public))

2 FeatherPanel System (public) endpoints from system/health.php: methods, paths, auth, permissions, rate limits, parameters and responses.

Last synced from FeatherPanel 15b94e9 on .

On this page

Defined in backend/app/routes/system/health.php. Authentication used here: Public. Read Authentication for how to send credentials and Rate limits and errors for the response envelope.

Paths, methods, permissions and rate limits come from the route file. Summaries, parameters and response codes come from the OpenAPI annotations on the controllers; endpoints without annotations show only what the route file declares.

Endpoints

GET/api/system/health

Auth: PublicRoute name: system-healthController: HealthController::indexroute source

Health check Lightweight liveness check for container health checks: confirms PHP answers and the database is reachable.

curl -X GET "$PANEL_URL/api/system/health" \
  -H "Accept: application/json"

Responses: 200 Healthy · 503 Database unreachable

HEAD/api/system/health

Auth: PublicRoute name: system-healthController: HealthController::indexroute source

Health check Lightweight liveness check for container health checks: confirms PHP answers and the database is reachable.

curl -X HEAD "$PANEL_URL/api/system/health" \
  -H "Accept: application/json"

Responses: 200 Healthy · 503 Database unreachable