Get Server Details

Retrieve detailed information about a specific server

GET /api/client/servers/:server

Get Server Details

cURL

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

200

{
  "400": {},
  "403": {},
  "404": {},
  "data": {
    "id": "<string>",
    "uuid": "<string>",
    "identifier": "<string>",
    "name": "<string>",
    "description": {},
    "status": {},
    "suspended": true,
    "node": {
      "id": {},
      "name": {}
    },
    "limits": {
      "memory": {},
      "disk": {},
      "cpu": {},
      "swap": {},
      "io": {}
    },
    "createdAt": "<string>",
    "allocations": {
      "primary": {
        "ip": "<string>",
        "port": 123,
        "description": "<string>"
      },
      "additional": [
        {}
      ]
    },
    "owner": {
      "id": {},
      "username": {}
    },
    "permissions": [
      {}
    ]
  }
}

Retrieves comprehensive details about a specific server, including resource limits, allocations, permissions, and current status.

Authentication

Requires a valid session token and the server.view permission on the specified server.

Path Parameters

server · string · required

Server identifier (short identifier or UUID)

Response

data · object

Server details object

Show PanelServerDetails

id · string · required

Internal database ID of the server

uuid · string · required

Unique identifier for the server

identifier · string · required

Short identifier used in URLs

name · string · required

Display name of the server

description · string | null

Server description

status · string | null

Current server status: offline, starting, running, stopping, or stopped

suspended · boolean · required

Whether the server is currently suspended

node · object · required

Information about the Wings node hosting this server

Show Node

id · string | null

Node ID

name · string | null

Node display name

limits · object · required

Server resource limits

Show Limits

memory · number | null

Memory limit in megabytes

disk · number | null

Disk limit in megabytes

cpu · number | null

CPU limit in percentage (100 = 1 core)

swap · number | null

Swap memory limit (reserved for future use)

io · number | null

IO weight/priority

createdAt · string · required

ISO 8601 timestamp of when the server was created

allocations · object · required

Network allocations for the server

Show Allocations

primary · object | null

Primary network allocation

Show Allocation

ip · string

IP address

port · number

Port number

description · string

Allocation description or notes

additional · array

Array of additional network allocations with the same structure as primary

owner · object · required

Information about the server owner

Show Owner

id · string | null

Owner user ID

username · string | null

Owner username

permissions · array

Array of permission strings the current user has on this server

Example Request

curl -X GET "https://panel.example.com/api/client/servers/my-server" \
  -H "Cookie: session=your-session-token"

Example Response

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "identifier": "my-server",
    "name": "My Game Server",
    "description": "Production Minecraft server",
    "status": "running",
    "suspended": false,
    "node": {
      "id": "node-123",
      "name": "US-East-1"
    },
    "limits": {
      "memory": 4096,
      "disk": 10240,
      "cpu": 200,
      "swap": null,
      "io": 500
    },
    "createdAt": "2024-01-15T10:30:00.000Z",
    "allocations": {
      "primary": {
        "ip": "192.168.1.100",
        "port": 25565,
        "description": "Main game port"
      },
      "additional": [
        {
          "ip": "192.168.1.100",
          "port": 25575,
          "description": "RCON port"
        }
      ]
    },
    "owner": {
      "id": "user-456",
      "username": "john_doe"
    },
    "permissions": [
      "server.view",
      "server.console",
      "server.power",
      "server.files.read",
      "server.files.write"
    ]
  }
}

Error Responses

400 · Bad Request

Server identifier is missing or invalid

403 · Forbidden

User does not have the server.view permission

404 · Not Found

Server not found or user does not have access