README

This project is for Pterodactyl Panel v1.x

Install Pterodactyl PHP API via Composer

You can install the Pterodactyl PHP API into your project using Composer.

$ composer require timdesm/pterodactyl-php-api

This project requires PHP version 5.6.4 or later.

Usage

First create an Application or Account (client) API key. Some features work only with Application or Client API keys. The API type is specified as a string, default is application. To use the Account API specify client as API type.

$pterodactylApi = new \Timdesm\PterodactylPhpApi\PterodactylApi(BASE_URI_HERE, API_KEY_HERE, API_TYPE_HERE);

Or use the following method

use Timdesm\PterodactylPhpApi\PterodactylApi;
$pterodactylApi = new PterodactylApi(BASE_URI_HERE, API_KEY_HERE, API_TYPE_HERE);

Some Handy Links

Documentation - The official Pterodactyl PHP API documentation pages.
Pterodactyl - The Pterodactyl Panel project website.
Pterodactyl API v1 - Pterodactyl API v1 Documentation.

Get Support!

First check the Documentation for more information regarding the usage of this project. Note: The documentation- pages are still under construction.

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

Contributing

If you want to contribute to this project, fetch it locally and open a pull request to get your branch merged.

License

timdesm/pterodactyl-php-api is licensed under the MIT License (MIT). Please see the license file for more information.

timdesm / pterodactyl-php-api

Maintainers

Details