List Servers

Retrieve a paginated list of all servers

GET /api/admin/servers

cURL

curl -X GET "https://panel.example.com/api/admin/servers?page=1&perPage=50" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Response

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "identifier": "a1b2c3d4",
      "name": "Production Server",
      "status": "running",
      "owner": {
        "id": "user-uuid",
        "username": "john.doe"
      },
      "node": {
        "id": "node-uuid",
        "name": "US-East-1"
      },
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 150,
      "count": 50,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 3
    }
  }
}

Authentication

This endpoint requires admin authentication and the servers:read permission.

Query Parameters

page · integer · default: "1"

Page number for pagination

perPage · integer · default: "50"

Number of servers per page (max: 100)

per_page · integer

Alternative parameter name for perPage

limit · integer

Alternative parameter name for perPage

Response

data · array

Array of server objects

Show Server Object

id · string

Server UUID

uuid · string

Server UUID

identifier · string

Short server identifier (8 characters)

name · string

Server name

status · string

Server status (installing, running, stopped, etc.)

owner · object

Server owner information

Show Owner Object

id · string

Owner user ID

username · string

Owner username

node · object

Node information

Show Node Object

id · string

Node ID

name · string

Node name

created_at · string

ISO 8601 timestamp of server creation

meta · object

Pagination metadata

Show Pagination Object

pagination.total · integer

Total number of servers

pagination.count · integer

Number of servers in current page

pagination.per_page · integer

Servers per page

pagination.current_page · integer

Current page number

pagination.total_pages · integer

Total number of pages

cURL

curl -X GET "https://panel.example.com/api/admin/servers?page=1&perPage=50" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Response

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "identifier": "a1b2c3d4",
      "name": "Production Server",
      "status": "running",
      "owner": {
        "id": "user-uuid",
        "username": "john.doe"
      },
      "node": {
        "id": "node-uuid",
        "name": "US-East-1"
      },
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 150,
      "count": 50,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 3
    }
  }
}