Skip to content

Pterodactyl PHP SDK

Latest Version on Packagist Total Downloads Software License Chat on Discord

Pterodactyl Panel PHP SDK(API wrapper).

Warning

This documentation is for v2 version, click here for v1 version.

The documentation has not been completed, you can create PRs to improve this documentation.

Quick start

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

composer require hcgcloud/pterodactyl-sdk:v2.0.0-alpha.2

# or use the development version for latest features
composer require hcgcloud/pterodactyl-sdk:dev-develop

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(BASE_URI, API_KEY, API_TYPE = 'application');
// API_TYPE can be set to 'application' or 'client'

Then you can call the apis.

Usage

Please check Api from the navigation for more details.

Support

You can get support by going to our Discord server or submitting new issue.

As a third-party API wrapper, We recommend you not asking for help elsewhere, or we may not be able to help you.

License

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