View .md

Observability endpoints (Admin API)

5 FeatherPanel Admin API endpoints from admin/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/admin/observability.php. Authentication used here: Admin. 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/admin/observability

Auth: AdminPermission: admin.settings.viewRoute name: admin-observability-showController: ObservabilityController::showroute source

Observability settings and status Metrics, logging and Loki settings (secrets are never returned) plus queue and endpoint status.

curl -X GET "$PANEL_URL/api/admin/observability" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Settings and status

PATCH/api/admin/observability

Auth: AdminPermission: admin.settings.editRoute name: admin-observability-updateController: ObservabilityController::updateroute source

Update observability settings

curl -X PATCH "$PANEL_URL/api/admin/observability" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Saved · 422 Invalid value

POST/api/admin/observability/metrics-token

Auth: AdminPermission: admin.settings.editDefault rate limit: 10 / minute (admin-observability)Route name: admin-observability-token-rotateController: ObservabilityController::rotateTokenroute source

Generate or rotate the metrics token Creates a new bearer token for /api/system/metrics and invalidates the previous one. The token is only returned in this response.

curl -X POST "$PANEL_URL/api/admin/observability/metrics-token" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 New token (shown once)

DELETE/api/admin/observability/metrics-token

Auth: AdminPermission: admin.settings.editRoute name: admin-observability-token-revokeController: ObservabilityController::revokeTokenroute source

Revoke the metrics token

curl -X DELETE "$PANEL_URL/api/admin/observability/metrics-token" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Revoked

POST/api/admin/observability/loki-test

Auth: AdminPermission: admin.settings.editDefault rate limit: 10 / minute (admin-observability)Route name: admin-observability-loki-testController: ObservabilityController::testLokiroute source

Send a test line to Loki Pushes one log line synchronously. Unsaved url, username, password, tenant and labels in the body override the saved values for this test only.

curl -X POST "$PANEL_URL/api/admin/observability/loki-test" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Result of the push