# Observability endpoints (System (public))

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

Source: https://featherpanel.com/docs/api/reference/system/observability/

Defined in [`backend/app/routes/system/observability.php`](https://github.com/MythicalLTD/FeatherPanel/blob/b7d8353f30f822c6aeae3b7be72604deedc5aa92/backend/app/routes/system/observability.php). Authentication used here: **Public**. Read [Authentication](https://featherpanel.com/docs/api/authentication/) for how to send credentials and [Rate limits and errors](https://featherpanel.com/docs/api/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: Public
- Route name: `system-metrics`
- Controller: [`ObservabilityController::metrics`](https://github.com/MythicalLTD/FeatherPanel/blob/b7d8353f30f822c6aeae3b7be72604deedc5aa92/backend/app/Controllers/System/ObservabilityController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/b7d8353f30f822c6aeae3b7be72604deedc5aa92/backend/app/routes/system/observability.php#L26)

**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).

```bash
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: Public
- Route name: `health-live`
- Controller: [`ObservabilityController::live`](https://github.com/MythicalLTD/FeatherPanel/blob/b7d8353f30f822c6aeae3b7be72604deedc5aa92/backend/app/Controllers/System/ObservabilityController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/b7d8353f30f822c6aeae3b7be72604deedc5aa92/backend/app/routes/system/observability.php#L41)

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

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

Responses: `200` Alive

### HEAD `/api/health/live`

- Auth: Public
- Route name: `health-live`
- Controller: [`ObservabilityController::live`](https://github.com/MythicalLTD/FeatherPanel/blob/b7d8353f30f822c6aeae3b7be72604deedc5aa92/backend/app/Controllers/System/ObservabilityController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/b7d8353f30f822c6aeae3b7be72604deedc5aa92/backend/app/routes/system/observability.php#L41)

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

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

Responses: `200` Alive

### GET `/api/health/ready`

- Auth: Public
- Route name: `health-ready`
- Controller: [`ObservabilityController::ready`](https://github.com/MythicalLTD/FeatherPanel/blob/b7d8353f30f822c6aeae3b7be72604deedc5aa92/backend/app/Controllers/System/ObservabilityController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/b7d8353f30f822c6aeae3b7be72604deedc5aa92/backend/app/routes/system/observability.php#L55)

**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.

```bash
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: Public
- Route name: `health-ready`
- Controller: [`ObservabilityController::ready`](https://github.com/MythicalLTD/FeatherPanel/blob/b7d8353f30f822c6aeae3b7be72604deedc5aa92/backend/app/Controllers/System/ObservabilityController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/b7d8353f30f822c6aeae3b7be72604deedc5aa92/backend/app/routes/system/observability.php#L55)

**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.

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

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