List Nodes with Application API¶

Get the collection of nodes.

Usage¶

<?php
    $pterodactyl->nodes(int $page = 1);
?>

Parameters¶

Parameter	Description	Rules
page	The page number

Returns¶

{
    "data": [{
        "id": 1,
        "public": true,
        "name": "location-1",
        "description": "location-1",
        "locationId": 1,
        "fqdn": "location-1.pterodactyl.panel",
        "scheme": "https",
        "behindProxy": false,
        "maintenanceMode": false,
        "memory": 10240,
        "memoryOverallocate": 0,
        "disk": 102400,
        "diskOverallocate": 0,
        "uploadSize": 100,
        "daemonListen": 8084,
        "daemonSftp": 2022,
        "daemonBase": "\/srv\/daemon-data",
        "createdAt": "2019-01-06T12:40:08+00:00",
        "updatedAt": "2019-10-29T12:24:28+00:00",
        "object": "node"
    }],
    "meta": {
        "pagination": {
            "total": 1,
            "count": 1,
            "per_page": 50,
            "current_page": 1,
            "total_pages": 1,
            "links": []
        }
    }
}

Example¶

<?php
    $nodes = $pterodactyl->nodes();
    print_r($nodes);
?>