View .md

Plugin Widgets endpoints (System (public))

1 FeatherPanel System (public) endpoint from system/plugin-widgets.php: methods, paths, auth, permissions, rate limits, parameters and responses.

Last synced from FeatherPanel 15b94e9 on .

On this page

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

Auth: PublicRoute name: plugin-widgetsController: PluginWidgetController::indexroute source

Get plugin widget configuration Retrieve widget configuration from all installed plugins. Widgets are organized by page and location, sorted by priority.

ParameterInTypeRequiredDescription
pagequerystringnoFilter widgets by page identifier (e.g., "server-console")

Response data: PluginWidgetsResponse

Response data fieldTypeDescription
widgetsobjectWidgets organized by page and location
curl -X GET "$PANEL_URL/api/system/plugin-widgets" \
  -H "Accept: application/json"

Plugin events: featherpanel:system:plugins:ui:error, featherpanel:system:plugins:ui:widgets:retrieved

Responses: 200 Plugin widget configuration retrieved successfully · 500 Internal server error - Failed to retrieve plugin widget configuration