codacy-badger/pterodactyl-sdk

Pterodactyl Panel API SDK for PHP (For Pterodactyl 0.7.x)

Pterodactyl PHP SDK

Important

As we are upgrading it to support version 0.7.x, some APIs are still not integrated, and we can't guarantee that there are no bugs. You can see a list that what we completed and planned below. Unless you already know the possible consequences, don't use it in production.

ToDo List

The following ticked items are upgraded & tested.

Server

All done, you can see available functions below.

User

All done, you can see available functions below.

Node

• $pterodactyl->nodes();
• $pterodactyl->node($nodeId);
• $pterodactyl->createNode(array $data);
• $pterodactyl->updateNode($nodeId, array $data);
• $pterodactyl->deleteNode($nodeId);

Node Instance

• $node->update(array $data);
• $node->delete();

Install

To install the SDK in your project you need to require the package via composer:

composer require hcgcloud/pterodactyl-sdk:dev-master

Then use Composer's autoload unless you are using a framework that support composer autoload:

require __DIR__.'/../vendor/autoload.php';

And finally create an instance of the SDK:

$pterodactyl = new \HCGCloud\Pterodactyl\Pterodactyl(API_KEY_HERE, BASE_URI_HERE);

Usage

Using the pterodactyl instance you may perform multiple actions as well as retrieve the different resources Pterodactyl's API provides:

$servers = $pterodactyl->servers();

This will give you an array of servers that you have access to, each server is represented by an instance of HCGCloud\Pterodactyl\Resources\Server, this instance has multiple public properties like $name, $id, $owner, $memory, and others.

You may also retrieve a single server using:

$server = $pterodactyl->server(SERVER_ID_HERE);

On multiple actions supported by this SDK you may need to pass some parameters, for example when creating a new server:

$server = $pterodactyl->createServer([
    "external_id" => "4",
    "name" => "APITest",
    "user" => 1,
    "egg" => 15,
    "pack" => 0,
    "docker_image" => "hub.tencentyun.com/unihc/pterodactyl_images:vcmp",
    "environment" => [
        //Not confirmed
        [
            "server_id" => "",
            "variable_id" => "",
            "variable_value" => ""
        ]
    ],
    "skip_scripts" => false,
    "limits" => [
        "memory" => 64,
        "swap" => 0,
        "disk" => 64,
        "io" => 500,
        "cpu" => 0
    ],
    "feature_limits" => [
        "databases" => 0,
        "allocations" => 0
    ],
    "startup" => "./mpsvrrel64 -port {{SERVER_PORT}}",
    "description" => "test description",
    "node_id" => 1,
    "nest_id" => 5,
    "allocation" => [
        "default" => "16",
        "additional" => [
            "17",
            "18"
        ]
    ]
]);

These parameters will be used in the POST request sent to Pterodactyl servers, you can find more information about the parameters needed in panel source: app\Http\Requests\Api\Application\Servers\StoreServerRequest.php

Notice that this request for example will only start the server creation process, your server might need a few minutes before it completes provisioning, you'll need to check the Server's $installed property to know if it's ready or not yet.

Or use the following code to create a new user:

$user = $pterodactyl->createUser([
    "external_id" => "2",
    "email" => '[email protected]',
    "username" => 'TestUser',
    "first_name" => 'Test',
    "last_name" => 'User',
    "language" => 'zh-cn',
    "password" => '123456'
]);

Managing Users

$pterodactyl->users();
$pterodactyl->user($userId);
$pterodactyl->userEx($userExternalId);
$pterodactyl->createUser(array $data);
$pterodactyl->updateUser($userId, array $data);
$pterodactyl->deleteUser($userId);

On a User instance you may also call:

$user->update(array $data);
$user->delete();

Managing Servers

//Works with Application API
$pterodactyl->servers();
$pterodactyl->server($serverId);
$pterodactyl->serverEx($serverExternalId);
$pterodactyl->createServer(array $data);
$pterodactyl->deleteServer($serverId);
$pterodactyl->suspendServer($serverId);
$pterodactyl->unsuspendServer($serverId);
$pterodactyl->reinstallServer($serverId);
$pterodactyl->rebuildServer($serverId);
$pterodactyl->updateServerStartup($serverId, array $data);

//Works with Account API
//Please note that the following $serverIdentifier is not same as $serverId, it is a short version of server UUID.
$pterodactyl->listServers();
$pterodactyl->getServer($serverIdentifier);
$pterodactyl->powerServer($serverIdentifier, $action); //'start', 'stop', 'restart', 'kill'
$pterodactyl->commandServer($serverIdentifier, $command);

On a Server instance you may also call:

//Works with Application API
$server->delete();
$server->suspend();
$server->unsuspend();
$server->reinstall();
$server->rebuild();

//Works with Account API
$server->power($action); //'start', 'stop', 'restart', 'kill
$server->command($command);

License

hcgcloud/pterodactyl-sdk is licensed under the MIT License (MIT). Please see the license file for more information.