View .md

Setup endpoints (Admin API)

3 FeatherPanel Admin API endpoints from admin/setup.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/setup.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/setup/status

Auth: AdminPermission: admin.settings.viewRoute name: admin-setup-statusController: SetupWizardController::statusroute source

Get setup wizard status

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

Responses: 200 Setup status

POST/api/admin/setup/complete

Auth: AdminPermission: admin.settings.editRoute name: admin-setup-completeController: SetupWizardController::completeroute source

Mark the setup wizard as completed

curl -X POST "$PANEL_URL/api/admin/setup/complete" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Setup marked completed

POST/api/admin/setup/reset

Auth: AdminPermission: admin.settings.editRoute name: admin-setup-resetController: SetupWizardController::resetroute source

Reopen the setup wizard

curl -X POST "$PANEL_URL/api/admin/setup/reset" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Setup reopened