Dashboard endpoints (Admin API)
3 FeatherPanel Admin API endpoints from admin/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/admin/dashboard.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/dashboard
Get dashboard statistics Retrieve comprehensive dashboard statistics including user counts, node counts, spell counts, server counts, and recent cron task status.
Response data field | Type | Description |
|---|---|---|
count | object | System resource counts |
cron | object | Cron task information |
changelog | string[] | System changelog entries (currently empty) |
version | object | Version information |
curl -X GET "$PANEL_URL/api/admin/dashboard" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Responses: 200 Dashboard statistics retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions · 500 Internal server error - Failed to fetch dashboard statistics
PUT/api/admin/dashboard/default-layout
Save the panel default dashboard layout
| Body field | Type | Required | Description |
|---|---|---|---|
layout | object | no |
curl -X PUT "$PANEL_URL/api/admin/dashboard/default-layout" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"layout":{}}'Responses: 200 Saved · 400 Invalid layout
DELETE/api/admin/dashboard/default-layout
Remove the panel default dashboard layout
curl -X DELETE "$PANEL_URL/api/admin/dashboard/default-layout" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Responses: 200 Removed