List Servers

GET /api/servers

List Servers

cURL

curl --request GET \
  --url https://api.example.com/api/servers

200

{
  "state": "<string>",
  "is_suspended": true,
  "utilization": {
    "state": "<string>",
    "memory_bytes": 123,
    "memory_limit_bytes": 123,
    "cpu_absolute": 123,
    "disk_bytes": 123,
    "network_rx_bytes": 123,
    "network_tx_bytes": 123,
    "uptime": 123
  },
  "configuration": {}
}

Returns all servers that are registered and configured on this Wings instance.

Authentication

Requires the Wings authentication token in the Authorization header:

Authorization: Bearer <token>

Response

Returns an array of server objects with their current state and resource utilization.

state · string

Current state of the server. One of: offline, starting, running, stopping

is_suspended · boolean

Whether the server is currently suspended

utilization · object

Current resource usage statistics

Show properties

state · string

Current process state

memory_bytes · integer

Current memory usage in bytes

memory_limit_bytes · integer

Memory limit in bytes

cpu_absolute · number

Absolute CPU usage percentage

disk_bytes · integer

Current disk usage in bytes

network_rx_bytes · integer

Network received bytes

network_tx_bytes · integer

Network transmitted bytes

uptime · integer

Server uptime in milliseconds

configuration · object

Server configuration details including UUID, limits, and allocations

Example Request

curl -X GET https://wings.example.com/api/servers \
  -H "Authorization: Bearer your-wings-token" \
  -H "Accept: application/json"

Example Response

[
  {
    "state": "running",
    "is_suspended": false,
    "utilization": {
      "state": "running",
      "memory_bytes": 536870912,
      "memory_limit_bytes": 1073741824,
      "cpu_absolute": 25.5,
      "disk_bytes": 2147483648,
      "network_rx_bytes": 1024000,
      "network_tx_bytes": 512000,
      "uptime": 3600000
    },
    "configuration": {
      "uuid": "8d3f9a2e-5c7b-4f1e-9d2a-6e8f1c3b5a7d",
      "suspended": false,
      "invocation": "java -Xms128M -Xmx1024M -jar server.jar",
      "skip_egg_scripts": false,
      "build": {
        "memory_limit": 1024,
        "swap": 0,
        "io_weight": 500,
        "cpu_limit": 100,
        "disk_space": 5120,
        "threads": "0-3"
      },
      "container": {
        "image": "ghcr.io/pterodactyl/yolks:java_17"
      },
      "allocations": {
        "default": {
          "ip": "0.0.0.0",
          "port": 25565
        },
        "mappings": {}
      }
    }
  }
]

Source Reference

Implemented in router/router_system.go:50