View .md

Dashboard endpoints (Client API: account)

3 FeatherPanel Client API: account endpoints from user/dashboard.php: methods, paths, auth, permissions, rate limits, parameters and responses.

Last synced from FeatherPanel 15b94e9 on .

On this page

Defined in backend/app/routes/user/dashboard.php. Authentication used here: Signed-in user. 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/user/dashboard/overview

Auth: Signed-in userDefault rate limit: 30 / minute (user-dashboard)Route name: user-dashboard-overviewController: DashboardOverviewController::overviewroute source

Dashboard overview Aggregated usage, status, backups and schedules across the servers the current user can access.

curl -X GET "$PANEL_URL/api/user/dashboard/overview" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Overview retrieved · 401 Unauthorized

GET/api/user/dashboard/default-layout

Auth: Signed-in userDefault rate limit: 30 / minute (user-dashboard)Route name: user-dashboard-default-layoutController: DashboardDefaultLayoutController::showroute source

Get the panel default dashboard layout

curl -X GET "$PANEL_URL/api/user/dashboard/default-layout" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Default layout or null

GET/api/user/dashboard/resource-history

Auth: Signed-in userDefault rate limit: 20 / minute (user-dashboard-history)Route name: user-dashboard-resource-historyController: ResourceHistoryController::dashboardroute source

Resource history for the dashboard Five minute CPU, memory and disk samples over the last 24 hours for every server the user owns or is a subuser on, plus totals per sample.

curl -X GET "$PANEL_URL/api/user/dashboard/resource-history" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 History retrieved · 401 Unauthorized