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

{
  "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
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/xyrapanel/panel/llms.txt

Use this file to discover all available pages before exploring further.

​
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
​
meta
object
Pagination metadata
curl -X GET "https://panel.example.com/api/admin/servers?page=1&perPage=50" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

{
  "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
    }
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us