Pterodactyl API v1
Nodes

List deployable nodes

Returns nodes that have enough resources for a new server with the given requirements

GET/api/application/nodes/deployable

Authorization

ApplicationToken
AuthorizationBearer <token>

Application API key (generated at /admin/api)

In: header

Query Parameters

memory*integer

Required memory in MB

disk*integer

Required disk space in MB

location_ids[]?array<>

Filter by location IDs

page?integer

Page number for pagination

Response Body

application/json

curl -X GET "https://pterodactyl.file.properties/api/application/nodes/deployable?memory=512&disk=1024&page=1" \  -H "Authorization: Bearer ptla_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \  -H "Accept: application/json"
{
  "object": "list",
  "data": [
    {
      "object": "node",
      "attributes": {
        "id": 0,
        "uuid": "string",
        "public": true,
        "name": "string",
        "description": "string",
        "location_id": 0,
        "fqdn": "string",
        "scheme": "string",
        "behind_proxy": true,
        "maintenance_mode": true,
        "memory": 0,
        "memory_overallocate": 0,
        "disk": 0,
        "disk_overallocate": 0,
        "upload_size": 0,
        "daemon_listen": 0,
        "daemon_sftp": 0,
        "daemon_base": "string",
        "created_at": "string",
        "updated_at": "string",
        "allocated_resources": {
          "memory": 0,
          "disk": 0
        }
      }
    }
  ]
}