Skip to main content
GET
/
api
/
client
/
servers
/
:server
Get Server Details
curl --request GET \
  --url https://api.example.com/api/client/servers/:server
{
  "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

​
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

Build docs developers (and LLMs) love

Get started for freeTalk to us