List nodes

Retrieves a list of nodes

Available include parameters

Parameter	Description
allocations	List of allocations added to the node
location	Information about the location the node is assigned to
servers	List of servers on the node

GET/api/application/nodes

Authorization

ApplicationToken

AuthorizationBearer <token>

Application API key (generated at /admin/api)

In: header

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.

filter[uuid]?string

Partial match on the node UUID.

filter[name]?string

Partial match on the node name.

filter[fqdn]?string

Partial match on the node FQDN.

filter[daemon_token_id]?string

Partial match on the daemon token identifier.

sort?string

Sort by id, uuid, memory or disk; prefix with - for descending.

page?integer

Page of results to return.

per_page?integer

Number of results per page (default 50).

Default50

Response Body

`application/json`

curl -X GET "https://pterodactyl.file.properties/api/application/nodes?include=allocations%2Clocation&filter%5Buuid%5D=1046d1d1&filter%5Bname%5D=Node+1&filter%5Bfqdn%5D=node.example.com&filter%5Bdaemon_token_id%5D=i6DHFj&sort=-memory&page=1&per_page=50" \  -H "Authorization: Bearer ptla_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \  -H "Accept: application/json"

{
  "object": "list",
  "data": [
    {
      "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
        }
      }
    },
    {
      "object": "node",
      "attributes": {
        "id": 3,
        "uuid": "71b15cf6-909a-4b60-aa04-abb4c8f98f61",
        "public": true,
        "name": "2",
        "description": "e",
        "location_id": 1,
        "fqdn": "pterodactyl.file.properties",
        "scheme": "https",
        "behind_proxy": false,
        "maintenance_mode": false,
        "memory": 100,
        "memory_overallocate": 0,
        "disk": 100,
        "disk_overallocate": 0,
        "upload_size": 100,
        "daemon_listen": 8080,
        "daemon_sftp": 2022,
        "daemon_base": "/var/lib/pterodactyl/volumes",
        "created_at": "2020-06-23T04:50:37+00:00",
        "updated_at": "2020-06-23T04:50:37+00:00",
        "allocated_resources": {
          "memory": 1536,
          "disk": 4096
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 2,
      "count": 2,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1,
      "links": {}
    }
  }
}