View .md

Observability endpoints (System (public))

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

Last synced from FeatherPanel b7d8353 on .

On this page

Defined in backend/app/routes/system/observability.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/metrics

Auth: PublicRoute name: system-metricsController: ObservabilityController::metricsroute source

Prometheus metrics Prometheus text exposition of panel, runtime, dependency and HTTP metrics. Disabled by default; enable it under Admin > Observability. Requires the metrics bearer token (or an allowed IP in IP mode).

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

Responses: 200 Metrics in Prometheus text format · 401 Missing or invalid metrics token · 403 Address not allowed or metrics access not configured · 404 Metrics are disabled

GET/api/health/live

Auth: PublicRoute name: health-liveController: ObservabilityController::liveroute source

Liveness probe Answers 200 as long as PHP serves requests. Does not touch the database.

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

Responses: 200 Alive

HEAD/api/health/live

Auth: PublicRoute name: health-liveController: ObservabilityController::liveroute source

Liveness probe Answers 200 as long as PHP serves requests. Does not touch the database.

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

Responses: 200 Alive

GET/api/health/ready

Auth: PublicRoute name: health-readyController: ObservabilityController::readyroute source

Readiness probe Checks the database, Redis, Mercure, storage and disk. 200 when the panel can serve traffic (status ok or degraded), 503 when a critical dependency fails.

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

Responses: 200 Ready (ok or degraded) · 503 Not ready

HEAD/api/health/ready

Auth: PublicRoute name: health-readyController: ObservabilityController::readyroute source

Readiness probe Checks the database, Redis, Mercure, storage and disk. 200 when the panel can serve traffic (status ok or degraded), 503 when a critical dependency fails.

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

Responses: 200 Ready (ok or degraded) · 503 Not ready