# Servers endpoints (Admin API)

> 21 FeatherPanel Admin API endpoints from admin/kpi/servers.php: methods, paths, auth, permissions, rate limits, parameters and responses.

Source: https://featherpanel.com/docs/api/reference/admin/kpi/servers/

Defined in [`backend/app/routes/admin/kpi/servers.php`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/admin/kpi/servers.php). Authentication used here: **Admin**. Read [Authentication](https://featherpanel.com/docs/api/authentication/) for how to send credentials and [Rate limits and errors](https://featherpanel.com/docs/api/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: Admin
- Permission: `admin.servers.view`
- Route name: `admin-analytics-servers-overview`
- Controller: [`ServerController::getServersOverview`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/KPI/ServerController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/admin/kpi/servers.php#L26)

**Get servers overview** Retrieve statistics about servers.

```bash
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: Admin
- Permission: `admin.servers.view`
- Route name: `admin-analytics-servers-by-realm`
- Controller: [`ServerController::getServersByRealm`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/KPI/ServerController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/admin/kpi/servers.php#L37)

**Get servers by realm** Retrieve server distribution across realms.

```bash
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: Admin
- Permission: `admin.servers.view`
- Route name: `admin-analytics-servers-by-spell`
- Controller: [`ServerController::getServersBySpell`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/KPI/ServerController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/admin/kpi/servers.php#L48)

**Get servers by spell** Retrieve server distribution across spells.

```bash
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: Admin
- Permission: `admin.servers.view`
- Route name: `admin-analytics-servers-database-usage`
- Controller: [`ServerController::getDatabaseUsage`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/KPI/ServerController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/admin/kpi/servers.php#L59)

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

```bash
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: Admin
- Permission: `admin.servers.view`
- Route name: `admin-analytics-servers-allocation-usage`
- Controller: [`ServerController::getAllocationUsage`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/KPI/ServerController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/admin/kpi/servers.php#L70)

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

```bash
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: Admin
- Permission: `admin.servers.view`
- Route name: `admin-analytics-servers-resources`
- Controller: [`ServerController::getResourceUsage`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/KPI/ServerController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/admin/kpi/servers.php#L81)

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

```bash
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: Admin
- Permission: `admin.servers.view`
- Route name: `admin-analytics-servers-status`
- Controller: [`ServerController::getStatusDistribution`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/KPI/ServerController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/admin/kpi/servers.php#L92)

**Get server status distribution** Retrieve distribution of servers by status.

```bash
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: Admin
- Permission: `admin.servers.view`
- Route name: `admin-analytics-servers-images`
- Controller: [`ServerController::getImageUsage`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/KPI/ServerController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/admin/kpi/servers.php#L103)

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

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `limit` | query | integer | no | Number of top images to retrieve (default: 10) |

```bash
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: Admin
- Permission: `admin.servers.view`
- Route name: `admin-analytics-servers-limits`
- Controller: [`ServerController::getLimitsDistribution`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/KPI/ServerController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/admin/kpi/servers.php#L114)

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

```bash
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: Admin
- Permission: `admin.servers.view`
- Route name: `admin-analytics-servers-dashboard`
- Controller: [`ServerController::getDashboard`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/KPI/ServerController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/admin/kpi/servers.php#L125)

**Get comprehensive server analytics dashboard** Retrieve all server analytics data.

```bash
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: Admin
- Permission: `admin.servers.view`
- Route name: `admin-analytics-servers-backups`
- Controller: [`ServerController::getBackupUsage`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/KPI/ServerController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/admin/kpi/servers.php#L136)

**Get backup usage statistics** Retrieve statistics about server backups.

```bash
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: Admin
- Permission: `admin.servers.view`
- Route name: `admin-analytics-servers-schedules`
- Controller: [`ServerController::getScheduleUsage`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/KPI/ServerController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/admin/kpi/servers.php#L147)

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

```bash
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: Admin
- Permission: `admin.servers.view`
- Route name: `admin-analytics-servers-subusers`
- Controller: [`ServerController::getSubuserStats`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/KPI/ServerController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/admin/kpi/servers.php#L158)

**Get subuser statistics** Retrieve statistics about server subusers.

```bash
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: Admin
- Permission: `admin.servers.view`
- Route name: `admin-analytics-servers-server-activities`
- Controller: [`ServerController::getServerActivityStats`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/KPI/ServerController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/admin/kpi/servers.php#L169)

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

```bash
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: Admin
- Permission: `admin.servers.view`
- Route name: `admin-analytics-servers-variables`
- Controller: [`ServerController::getVariableStats`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/KPI/ServerController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/admin/kpi/servers.php#L180)

**Get variable usage statistics** Retrieve statistics about server variables.

```bash
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: Admin
- Permission: `admin.servers.view`
- Route name: `admin-analytics-servers-creation-trend`
- Controller: [`ServerController::getCreationTrend`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/KPI/ServerController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/admin/kpi/servers.php#L191)

**Get server creation trend** Retrieve server creation trends over time.

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `days` | query | integer | no | Number of days to look back (default: 30) |

```bash
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/resource-trends`

- Auth: Admin
- Permission: `admin.servers.view`
- Route name: `admin-analytics-servers-resource-trends`
- Controller: [`ServerController::getResourceTrends`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/KPI/ServerController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/admin/kpi/servers.php#L202)

**Get resource allocation trends** Retrieve resource allocation trends over time.

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `days` | query | integer | no | Number of days to look back (default: 30) |

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

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

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

- Auth: Admin
- Permission: `admin.servers.view`
- Route name: `admin-analytics-servers-age-distribution`
- Controller: [`ServerController::getAgeDistribution`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/KPI/ServerController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/admin/kpi/servers.php#L213)

**Get server age distribution** Retrieve server age distribution.

```bash
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: Admin
- Permission: `admin.servers.view`
- Route name: `admin-analytics-servers-resource-distribution`
- Controller: [`ServerController::getResourceDistribution`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/KPI/ServerController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/admin/kpi/servers.php#L224)

**Get resource distribution** Retrieve how resources are distributed across servers.

```bash
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: Admin
- Permission: `admin.servers.view`
- Route name: `admin-analytics-servers-installation`
- Controller: [`ServerController::getInstallationStats`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/KPI/ServerController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/admin/kpi/servers.php#L235)

**Get installation statistics** Retrieve server installation statistics.

```bash
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: Admin
- Permission: `admin.servers.view`
- Route name: `admin-analytics-servers-configuration`
- Controller: [`ServerController::getConfigurationPatterns`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/KPI/ServerController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/admin/kpi/servers.php#L246)

**Get configuration patterns** Retrieve server configuration patterns.

```bash
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