Pterodactyl API v1
Nodes

Node details

Retrieves the specified node

Available include parameters

ParameterDescription
allocationsList of allocations added to the node
locationInformation about the location the node is assigned to
serversList of servers on the node
GET/api/application/nodes/{node}

Authorization

ApplicationToken
AuthorizationBearer <token>

Application API key (generated at /admin/api)

In: header

Path Parameters

node*integer

Node 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/application/nodes/1?include=allocations%2Clocation" \  -H "Authorization: Bearer ptla_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \  -H "Accept: application/json"
{
  "object": "node",
  "attributes": {
    "id": 1,
    "uuid": "1046d1d1-b8ef-4771-82b1-2b5946d33397",
    "public": true,
    "name": "Test",
    "description": "Test",
    "location_id": 1,
    "fqdn": "pterodactyl.file.properties",
    "scheme": "https",
    "behind_proxy": false,
    "maintenance_mode": false,
    "memory": 2048,
    "memory_overallocate": 0,
    "disk": 5000,
    "disk_overallocate": 0,
    "upload_size": 100,
    "daemon_listen": 8080,
    "daemon_sftp": 2022,
    "daemon_base": "/srv/daemon-data",
    "created_at": "2019-12-22T04:44:51+00:00",
    "updated_at": "2019-12-22T04:44:51+00:00",
    "allocated_resources": {
      "memory": 1536,
      "disk": 4096
    }
  }
}