Server details

Retrieves information about the specified server

Available include parameters

Parameter	Description
egg	Information about the egg the server uses
subusers	List of subusers on the server

GET/api/client/servers/{server}

Authorization

ClientToken

AuthorizationBearer <token>

Client API key (generated at /account/api)

In: header

Path Parameters

server*string

Server identifier (short 8-character ID)

Query Parameters

include?string

Comma-separated list of related resources to embed in each returned object. Accepted values are listed in the include-parameters table above.

Response Body

`application/json`

curl -X GET "https://pterodactyl.file.properties/api/client/servers/1a7ce997?include=egg%2Csubusers" \  -H "Authorization: Bearer ptlc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \  -H "Accept: application/json"

{
  "object": "server",
  "attributes": {
    "server_owner": true,
    "identifier": "1a7ce997",
    "__deprecated_uuid_short": "1a7ce997",
    "server_identifier": "serv_bld4gxw2rvcd5o7y27nsn5zuuy",
    "internal_id": 69,
    "uuid": "1a7ce997-259b-452e-8b4e-cecc464142ca",
    "name": "Wuhu Island",
    "node": "Test",
    "is_node_under_maintenance": false,
    "sftp_details": {
      "ip": "pterodactyl.file.properties",
      "port": 2022
    },
    "description": "Matt from Wii Sports",
    "limits": {
      "memory": 512,
      "swap": 0,
      "disk": 200,
      "io": 500,
      "cpu": 0,
      "threads": null,
      "oom_disabled": true
    },
    "invocation": "java -Xms128M -Xmx512M -jar server.jar",
    "docker_image": "ghcr.io/pterodactyl/yolks:java_17",
    "egg_features": [
      "eula",
      "java_version",
      "pid_limit"
    ],
    "feature_limits": {
      "databases": 5,
      "allocations": 5,
      "backups": 2
    },
    "status": null,
    "is_suspended": false,
    "is_installing": false,
    "is_transferring": false,
    "relationships": {
      "allocations": {
        "object": "list",
        "data": [
          {
            "object": "allocation",
            "attributes": {
              "id": 1,
              "ip": "45.86.168.218",
              "ip_alias": null,
              "port": 25565,
              "notes": null,
              "is_default": true
            }
          },
          {
            "object": "allocation",
            "attributes": {
              "id": 2,
              "ip": "45.86.168.218",
              "ip_alias": null,
              "port": 25566,
              "notes": "Votifier",
              "is_default": false
            }
          }
        ]
      },
      "variables": {
        "object": "list",
        "data": [
          {
            "object": "egg_variable",
            "attributes": {
              "name": "Server Jar File",
              "description": "The name of the server jarfile to run the server with.",
              "env_variable": "SERVER_JARFILE",
              "default_value": "server.jar",
              "server_value": "server.jar",
              "is_editable": true,
              "rules": "required|regex:/^([\\w\\d._-]+)(\\.jar)$/"
            }
          }
        ]
      }
    }
  },
  "meta": {
    "is_server_owner": true,
    "user_permissions": [
      "*",
      "admin.websocket.errors",
      "admin.websocket.install"
    ]
  }
}