List allocations

Lists allocations added to the node

Available include parameters

Parameter	Description
node	Information about the node the allocation belongs to
server	Information about the server the allocation belongs to

GET/api/application/nodes/{node}/allocations

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.

filter[ip]?string

Exact match on the IP address.

filter[port]?string

Exact match on the port.

filter[ip_alias]?string

Partial match on the IP alias.

filter[server_id]?string

Allocations assigned to this server ID. Pass an empty or non-numeric value to list unassigned allocations.

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/1/allocations?include=node%2Cserver&filter%5Bip%5D=45.86.168.218&filter%5Bport%5D=25565&filter%5Bip_alias%5D=eu.example.com&filter%5Bserver_id%5D=5&page=1&per_page=50" \  -H "Authorization: Bearer ptla_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \  -H "Accept: application/json"

{
  "object": "list",
  "data": [
    {
      "object": "allocation",
      "attributes": {
        "id": 1,
        "ip": "45.86.168.218",
        "alias": null,
        "port": 25565,
        "notes": null,
        "assigned": true
      }
    },
    {
      "object": "allocation",
      "attributes": {
        "id": 2,
        "ip": "45.86.168.218",
        "alias": null,
        "port": 25566,
        "notes": "Votifier",
        "assigned": true
      }
    },
    {
      "object": "allocation",
      "attributes": {
        "id": 3,
        "ip": "45.86.168.218",
        "alias": null,
        "port": 25567,
        "notes": null,
        "assigned": false
      }
    },
    {
      "object": "allocation",
      "attributes": {
        "id": 4,
        "ip": "45.86.168.218",
        "alias": null,
        "port": 25568,
        "notes": null,
        "assigned": false
      }
    },
    {
      "object": "allocation",
      "attributes": {
        "id": 5,
        "ip": "45.86.168.218",
        "alias": null,
        "port": 25569,
        "notes": null,
        "assigned": false
      }
    },
    {
      "object": "allocation",
      "attributes": {
        "id": 6,
        "ip": "45.86.168.218",
        "alias": null,
        "port": 25570,
        "notes": null,
        "assigned": false
      }
    },
    {
      "object": "allocation",
      "attributes": {
        "id": 8,
        "ip": "10.0.0.1",
        "alias": null,
        "port": 25565,
        "notes": null,
        "assigned": false
      }
    },
    {
      "object": "allocation",
      "attributes": {
        "id": 9,
        "ip": "45.86.168.218",
        "alias": null,
        "port": 25571,
        "notes": null,
        "assigned": false
      }
    },
    {
      "object": "allocation",
      "attributes": {
        "id": 10,
        "ip": "45.86.168.218",
        "alias": null,
        "port": 25572,
        "notes": null,
        "assigned": false
      }
    },
    {
      "object": "allocation",
      "attributes": {
        "id": 11,
        "ip": "45.86.168.218",
        "alias": null,
        "port": 25573,
        "notes": null,
        "assigned": false
      }
    },
    {
      "object": "allocation",
      "attributes": {
        "id": 12,
        "ip": "45.86.168.218",
        "alias": null,
        "port": 25574,
        "notes": null,
        "assigned": false
      }
    },
    {
      "object": "allocation",
      "attributes": {
        "id": 13,
        "ip": "45.86.168.218",
        "alias": null,
        "port": 25575,
        "notes": null,
        "assigned": false
      }
    },
    {
      "object": "allocation",
      "attributes": {
        "id": 14,
        "ip": "45.86.168.218",
        "alias": null,
        "port": 25576,
        "notes": null,
        "assigned": false
      }
    },
    {
      "object": "allocation",
      "attributes": {
        "id": 15,
        "ip": "45.86.168.218",
        "alias": null,
        "port": 25577,
        "notes": null,
        "assigned": false
      }
    },
    {
      "object": "allocation",
      "attributes": {
        "id": 16,
        "ip": "45.86.168.218",
        "alias": null,
        "port": 25578,
        "notes": null,
        "assigned": false
      }
    },
    {
      "object": "allocation",
      "attributes": {
        "id": 17,
        "ip": "45.86.168.218",
        "alias": null,
        "port": 25579,
        "notes": null,
        "assigned": false
      }
    },
    {
      "object": "allocation",
      "attributes": {
        "id": 18,
        "ip": "45.86.168.218",
        "alias": null,
        "port": 25580,
        "notes": null,
        "assigned": false
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 17,
      "count": 17,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1,
      "links": {}
    }
  }
}