Type at least two characters.

↑ ↓ moveEnter openEsc close
View .md

Servers endpoints (Admin API)

21 FeatherPanel Admin API endpoints from admin/kpi/servers.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/kpi/servers.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/analytics/servers/overview

Auth: AdminPermission: admin.servers.viewRoute name: admin-analytics-servers-overviewController: ServerController::getServersOverviewroute source

Get servers overview Retrieve statistics about servers.

curl -X GET "$PANEL_URL/api/admin/analytics/servers/overview" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Servers overview retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

GET/api/admin/analytics/servers/by-realm

Auth: AdminPermission: admin.servers.viewRoute name: admin-analytics-servers-by-realmController: ServerController::getServersByRealmroute source

Get servers by realm Retrieve server distribution across realms.

curl -X GET "$PANEL_URL/api/admin/analytics/servers/by-realm" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Servers by realm retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

GET/api/admin/analytics/servers/by-spell

Auth: AdminPermission: admin.servers.viewRoute name: admin-analytics-servers-by-spellController: ServerController::getServersBySpellroute source

Get servers by spell Retrieve server distribution across spells.

curl -X GET "$PANEL_URL/api/admin/analytics/servers/by-spell" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Servers by spell retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

GET/api/admin/analytics/servers/database-usage

Auth: AdminPermission: admin.servers.viewRoute name: admin-analytics-servers-database-usageController: ServerController::getDatabaseUsageroute source

Get database usage per server Retrieve statistics about database usage patterns across servers.

curl -X GET "$PANEL_URL/api/admin/analytics/servers/database-usage" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Database usage retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

GET/api/admin/analytics/servers/allocation-usage

Auth: AdminPermission: admin.servers.viewRoute name: admin-analytics-servers-allocation-usageController: ServerController::getAllocationUsageroute source

Get allocation usage per server Retrieve statistics about allocation usage patterns across servers.

curl -X GET "$PANEL_URL/api/admin/analytics/servers/allocation-usage" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Allocation usage retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

GET/api/admin/analytics/servers/resources

Auth: AdminPermission: admin.servers.viewRoute name: admin-analytics-servers-resourcesController: ServerController::getResourceUsageroute source

Get server resource usage Retrieve statistics about resource allocation across servers.

curl -X GET "$PANEL_URL/api/admin/analytics/servers/resources" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Resource usage retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

GET/api/admin/analytics/servers/status

Auth: AdminPermission: admin.servers.viewRoute name: admin-analytics-servers-statusController: ServerController::getStatusDistributionroute source

Get server status distribution Retrieve distribution of servers by status.

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

Responses: 200 Status distribution retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

GET/api/admin/analytics/servers/images

Auth: AdminPermission: admin.servers.viewRoute name: admin-analytics-servers-imagesController: ServerController::getImageUsageroute source

Get Docker image usage Retrieve statistics about most used Docker images.

ParameterInTypeRequiredDescription
limitqueryintegernoNumber of top images to retrieve (default: 10)
curl -X GET "$PANEL_URL/api/admin/analytics/servers/images" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Image usage retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

GET/api/admin/analytics/servers/limits

Auth: AdminPermission: admin.servers.viewRoute name: admin-analytics-servers-limitsController: ServerController::getLimitsDistributionroute source

Get server limits distribution Retrieve statistics about database and backup limits.

curl -X GET "$PANEL_URL/api/admin/analytics/servers/limits" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Limits distribution retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

GET/api/admin/analytics/servers/dashboard

Auth: AdminPermission: admin.servers.viewRoute name: admin-analytics-servers-dashboardController: ServerController::getDashboardroute source

Get comprehensive server analytics dashboard Retrieve all server analytics data.

curl -X GET "$PANEL_URL/api/admin/analytics/servers/dashboard" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Server dashboard retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

GET/api/admin/analytics/servers/backups

Auth: AdminPermission: admin.servers.viewRoute name: admin-analytics-servers-backupsController: ServerController::getBackupUsageroute source

Get backup usage statistics Retrieve statistics about server backups.

curl -X GET "$PANEL_URL/api/admin/analytics/servers/backups" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Backup usage retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

GET/api/admin/analytics/servers/schedules

Auth: AdminPermission: admin.servers.viewRoute name: admin-analytics-servers-schedulesController: ServerController::getScheduleUsageroute source

Get schedule usage statistics Retrieve statistics about server schedules and tasks.

curl -X GET "$PANEL_URL/api/admin/analytics/servers/schedules" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Schedule usage retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

GET/api/admin/analytics/servers/subusers

Auth: AdminPermission: admin.servers.viewRoute name: admin-analytics-servers-subusersController: ServerController::getSubuserStatsroute source

Get subuser statistics Retrieve statistics about server subusers.

curl -X GET "$PANEL_URL/api/admin/analytics/servers/subusers" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Subuser statistics retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

GET/api/admin/analytics/servers/server-activities

Auth: AdminPermission: admin.servers.viewRoute name: admin-analytics-servers-server-activitiesController: ServerController::getServerActivityStatsroute source

Get server activity statistics Retrieve statistics about server-specific activities.

curl -X GET "$PANEL_URL/api/admin/analytics/servers/server-activities" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Server activity statistics retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

GET/api/admin/analytics/servers/variables

Auth: AdminPermission: admin.servers.viewRoute name: admin-analytics-servers-variablesController: ServerController::getVariableStatsroute source

Get variable usage statistics Retrieve statistics about server variables.

curl -X GET "$PANEL_URL/api/admin/analytics/servers/variables" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Variable statistics retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

GET/api/admin/analytics/servers/creation-trend

Auth: AdminPermission: admin.servers.viewRoute name: admin-analytics-servers-creation-trendController: ServerController::getCreationTrendroute source

Get server creation trend Retrieve server creation trends over time.

ParameterInTypeRequiredDescription
daysqueryintegernoNumber of days to look back (default: 30)
curl -X GET "$PANEL_URL/api/admin/analytics/servers/creation-trend" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Creation trend retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

GET/api/admin/analytics/servers/age-distribution

Auth: AdminPermission: admin.servers.viewRoute name: admin-analytics-servers-age-distributionController: ServerController::getAgeDistributionroute source

Get server age distribution Retrieve server age distribution.

curl -X GET "$PANEL_URL/api/admin/analytics/servers/age-distribution" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Age distribution retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

GET/api/admin/analytics/servers/resource-distribution

Auth: AdminPermission: admin.servers.viewRoute name: admin-analytics-servers-resource-distributionController: ServerController::getResourceDistributionroute source

Get resource distribution Retrieve how resources are distributed across servers.

curl -X GET "$PANEL_URL/api/admin/analytics/servers/resource-distribution" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Resource distribution retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

GET/api/admin/analytics/servers/installation

Auth: AdminPermission: admin.servers.viewRoute name: admin-analytics-servers-installationController: ServerController::getInstallationStatsroute source

Get installation statistics Retrieve server installation statistics.

curl -X GET "$PANEL_URL/api/admin/analytics/servers/installation" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Installation statistics retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

GET/api/admin/analytics/servers/configuration

Auth: AdminPermission: admin.servers.viewRoute name: admin-analytics-servers-configurationController: ServerController::getConfigurationPatternsroute source

Get configuration patterns Retrieve server configuration patterns.

curl -X GET "$PANEL_URL/api/admin/analytics/servers/configuration" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Configuration patterns retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

Written from the source:FeatherPanel/backend/app/routes/admin/kpi/servers.php
View source on GitHubReport a problemLast updated