Type at least two characters.

↑ ↓ moveEnter openEsc close
View .md

Inactive Cleanup endpoints (Admin API)

11 FeatherPanel Admin API endpoints from admin/inactive-cleanup.php: methods, paths, auth, permissions, rate limits, parameters and responses.

Last synced from FeatherPanel 3faf369 on .

On this page

Defined in backend/app/routes/admin/inactive-cleanup.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/inactive-cleanup/settings

Auth: AdminPermission: admin.servers.viewRoute name: admin-inactive-cleanup-settingsController: InactiveCleanupController::settingsroute source
curl -X GET "$PANEL_URL/api/admin/inactive-cleanup/settings" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PUT/api/admin/inactive-cleanup/settings

Auth: AdminPermission: admin.servers.deleteRoute name: admin-inactive-cleanup-settings-updateController: InactiveCleanupController::updateSettingsroute source
curl -X PUT "$PANEL_URL/api/admin/inactive-cleanup/settings" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/admin/inactive-cleanup/preview

Auth: AdminPermission: admin.servers.viewRoute name: admin-inactive-cleanup-previewController: InactiveCleanupController::previewroute source
curl -X POST "$PANEL_URL/api/admin/inactive-cleanup/preview" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/admin/inactive-cleanup/run

Auth: AdminPermission: admin.servers.deleteRoute name: admin-inactive-cleanup-runController: InactiveCleanupController::runroute source
curl -X POST "$PANEL_URL/api/admin/inactive-cleanup/run" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/admin/inactive-cleanup/archives

Auth: AdminPermission: admin.servers.viewRoute name: admin-inactive-cleanup-archivesController: InactiveCleanupController::archivesroute source
curl -X GET "$PANEL_URL/api/admin/inactive-cleanup/archives" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/admin/inactive-cleanup/servers/{id}

Auth: AdminPermission: admin.servers.viewRoute name: admin-inactive-cleanup-serverController: InactiveCleanupController::serverStatusroute source
ParameterInTypeRequiredDescription
idpath-yes
curl -X GET "$PANEL_URL/api/admin/inactive-cleanup/servers/$ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PUT/api/admin/inactive-cleanup/servers/{id}/exempt

Auth: AdminPermission: admin.servers.editRoute name: admin-inactive-cleanup-server-exemptController: InactiveCleanupController::setExemptroute source
ParameterInTypeRequiredDescription
idpath-yes
curl -X PUT "$PANEL_URL/api/admin/inactive-cleanup/servers/$ID/exempt" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/admin/disk-quota/settings

Auth: AdminPermission: admin.users.listRoute name: admin-disk-quota-settingsController: DiskQuotaController::settingsroute source
curl -X GET "$PANEL_URL/api/admin/disk-quota/settings" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PUT/api/admin/disk-quota/settings

Auth: AdminPermission: admin.settings.editRoute name: admin-disk-quota-settings-updateController: DiskQuotaController::updateSettingsroute source
curl -X PUT "$PANEL_URL/api/admin/disk-quota/settings" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/admin/disk-quota/users/{id}

Auth: AdminPermission: admin.users.listRoute name: admin-disk-quota-userController: DiskQuotaController::showroute source
ParameterInTypeRequiredDescription
idpath-yes
curl -X GET "$PANEL_URL/api/admin/disk-quota/users/$ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PUT/api/admin/disk-quota/users/{id}

Auth: AdminPermission: admin.users.editRoute name: admin-disk-quota-user-updateController: DiskQuotaController::updateroute source
ParameterInTypeRequiredDescription
idpath-yes
curl -X PUT "$PANEL_URL/api/admin/disk-quota/users/$ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
Written from the source:FeatherPanel/backend/app/routes/admin/inactive-cleanup.php
View source on GitHubReport a problemLast updated