View .md

Status endpoints (Client API: account)

1 FeatherPanel Client API: account endpoint from user/status.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/status.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/status

Auth: Signed-in userDefault rate limit: 60 / minute (user-status)Route name: user-statusController: NodeStatusController::getStatusroute source

Get public status page data Retrieve status information based on configured visibility settings. Only returns data that is enabled in settings.

Response data fieldTypeDescription
enabledbooleanWhether status page is enabled
dataobjectStatus data based on settings
curl -X GET "$PANEL_URL/api/user/status" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Status data retrieved successfully · 403 Status page is disabled