Type at least two characters.

↑ ↓ moveEnter openEsc close
View .md

Infrastructure endpoints (Admin API)

11 FeatherPanel Admin API endpoints from admin/kpi/infrastructure.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/infrastructure.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/locations/overview

Auth: AdminPermission: admin.locations.viewRoute name: admin-analytics-locations-overviewController: InfrastructureController::getLocationsOverviewroute source

Get locations overview Retrieve statistics about locations.

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

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

GET/api/admin/analytics/nodes/overview

Auth: AdminPermission: admin.nodes.viewRoute name: admin-analytics-nodes-overviewController: InfrastructureController::getNodesOverviewroute source

Get nodes overview Retrieve statistics about nodes.

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

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

GET/api/admin/analytics/nodes/by-location

Auth: AdminPermission: admin.nodes.viewRoute name: admin-analytics-nodes-by-locationController: InfrastructureController::getNodesByLocationroute source

Get nodes by location Retrieve node distribution across locations.

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

Responses: 200 Nodes by location retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

GET/api/admin/analytics/nodes/resources

Auth: AdminPermission: admin.nodes.viewRoute name: admin-analytics-nodes-resourcesController: InfrastructureController::getNodeResourcesroute source

Get node resource allocation Retrieve resource allocation statistics for all nodes.

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

Responses: 200 Node resources retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

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

Auth: AdminPermission: admin.servers.viewRoute name: admin-analytics-servers-by-nodeController: InfrastructureController::getServersByNoderoute source

Get servers by node Retrieve server distribution across nodes.

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

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

GET/api/admin/analytics/allocations/overview

Auth: AdminPermission: admin.allocations.viewRoute name: admin-analytics-allocations-overviewController: InfrastructureController::getAllocationsOverviewroute source

Get allocations overview Retrieve statistics about allocations.

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

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

GET/api/admin/analytics/allocations/by-node

Auth: AdminPermission: admin.allocations.viewRoute name: admin-analytics-allocations-by-nodeController: InfrastructureController::getAllocationsByNoderoute source

Get allocations by node Retrieve allocation distribution across nodes.

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

Responses: 200 Allocations by node retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

GET/api/admin/analytics/ports/usage

Auth: AdminPermission: admin.allocations.viewRoute name: admin-analytics-ports-usageController: InfrastructureController::getPortUsageroute source

Get port usage statistics Retrieve statistics about most used ports.

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

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

GET/api/admin/analytics/ips/usage

Auth: AdminPermission: admin.allocations.viewRoute name: admin-analytics-ips-usageController: InfrastructureController::getIpUsageroute source

Get IP usage statistics Retrieve statistics about most used IP addresses.

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

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

GET/api/admin/analytics/databases/overview

Auth: AdminPermission: admin.databases.viewRoute name: admin-analytics-databases-overviewController: InfrastructureController::getDatabasesOverviewroute source

Get databases overview Retrieve statistics about database hosts.

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

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

GET/api/admin/analytics/infrastructure/dashboard

Auth: AdminPermission: admin.nodes.viewRoute name: admin-analytics-infrastructure-dashboardController: InfrastructureController::getDashboardroute source

Get comprehensive infrastructure dashboard Retrieve all infrastructure analytics data.

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

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

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