Server details by external ID

Retrieves a server by its external ID

Available include parameters

Parameter	Description
allocations	List of allocations assigned to the server
user	Information about the server owner
subusers	List of users added to the server
nest	Information about the server's egg nest
egg	Information about the server's egg
variables	List of server variables
location	Information about server's node location
node	Information about the server's node
databases	List of databases on the server
transfer	Information about the server's transfer (null unless a transfer is in progress)

GET/api/application/servers/external/{external_id}

Authorization

ApplicationToken

AuthorizationBearer <token>

Application API key (generated at /admin/api)

In: header

Path Parameters

external_id*string

External identifier

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/application/servers/external/RemoteId1?include=allocations%2Cuser" \  -H "Authorization: Bearer ptla_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \  -H "Accept: application/json"

{
  "object": "server",
  "attributes": {
    "id": 5,
    "external_id": "RemoteId1",
    "uuid": "1a7ce997-259b-452e-8b4e-cecc464142ca",
    "identifier": "1a7ce997",
    "name": "Gaming",
    "description": "Matt from Wii Sports",
    "status": null,
    "suspended": false,
    "limits": {
      "memory": 512,
      "swap": 0,
      "disk": 200,
      "io": 500,
      "cpu": 0,
      "threads": null,
      "oom_disabled": false
    },
    "feature_limits": {
      "databases": 5,
      "allocations": 5,
      "backups": 2
    },
    "user": 1,
    "node": 1,
    "allocation": 1,
    "nest": 1,
    "egg": 5,
    "container": {
      "startup_command": "java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}",
      "image": "quay.io/pterodactyl/core:java",
      "installed": 1,
      "environment": {
        "SERVER_JARFILE": "server.jar",
        "VANILLA_VERSION": "latest",
        "STARTUP": "java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}",
        "P_SERVER_LOCATION": "GB",
        "P_SERVER_UUID": "1a7ce997-259b-452e-8b4e-cecc464142ca",
        "P_SERVER_ALLOCATION_LIMIT": 5
      }
    },
    "updated_at": "2020-07-19T15:22:39+00:00",
    "created_at": "2019-12-23T06:46:27+00:00"
  }
}