https://github.com/hcgcloud/pterodactyl-sdk
Pterodactyl Panel PHP SDK/API wrapper
https://github.com/hcgcloud/pterodactyl-sdk
api api-wrapper php pterodactyl pterodactyl-api pterodactyl-panel pterodactyl-panel-api sdk
Last synced: 5 months ago
JSON representation
Pterodactyl Panel PHP SDK/API wrapper
- Host: GitHub
- URL: https://github.com/hcgcloud/pterodactyl-sdk
- Owner: hcgcloud
- License: mit
- Archived: true
- Created: 2019-01-31T02:00:40.000Z (over 7 years ago)
- Default Branch: develop
- Last Pushed: 2022-03-30T07:46:11.000Z (about 4 years ago)
- Last Synced: 2025-10-28T13:31:01.628Z (8 months ago)
- Topics: api, api-wrapper, php, pterodactyl, pterodactyl-api, pterodactyl-panel, pterodactyl-panel-api, sdk
- Language: PHP
- Homepage: https://hcgcloud.github.io/pterodactyl-sdk-docs/
- Size: 143 KB
- Stars: 32
- Watchers: 7
- Forks: 23
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Pterodactyl PHP SDK
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Total Downloads][ico-downloads]][link-downloads]
[![Software License][ico-license]](LICENSE.md)
[![Chat on Discord][ico-chat]][link-chat]
[Documentation](https://hcgcloud.github.io/pterodactyl-sdk-docs)
## Quick start
**For Pterodactyl Panel v1**, you may need to install `v2` version of this sdk, otherwise some functions may not work properly.
There is no stable [version](https://github.com/hcgcloud/pterodactyl-sdk/releases) and full [documentation](https://hcgcloud.github.io/pterodactyl-sdk-docs-v2/) for `v2` yet, you may need to read the source code to use this sdk.
```bash
composer require hcgcloud/pterodactyl-sdk:v2.0.0-alpha.2
```
---
To install the SDK in your project you need to require the package via [composer](http://getcomposer.org):
```bash
composer require hcgcloud/pterodactyl-sdk
```
Then use Composer's autoload unless you are using a framework that support composer autoload:
```php
require __DIR__.'/../vendor/autoload.php';
```
And finally create an instance of the SDK:
```php
$pterodactyl = new \HCGCloud\Pterodactyl\Pterodactyl(API_KEY_HERE, BASE_URI_HERE);
```
Then you can call the apis.
## Usage
Please check the [documentation](https://hcgcloud.github.io/pterodactyl-sdk-docs) for more details.
## Support
You can get support by going to our [Discord server](https://discord.gg/5KnNVfv) or [submitting new issue](https://github.com/hcgcloud/pterodactyl-sdk/issues/new).
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](LICENSE.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/hcgcloud/pterodactyl-sdk.svg
[ico-license]: https://img.shields.io/badge/license-MIT-green.svg
[ico-downloads]: https://img.shields.io/packagist/dt/hcgcloud/pterodactyl-sdk.svg
[ico-chat]: https://img.shields.io/discord/609764930899673092
[link-packagist]: https://packagist.org/packages/hcgcloud/pterodactyl-sdk
[link-downloads]: https://packagist.org/packages/hcgcloud/pterodactyl-sdk
[link-chat]: https://discord.gg/5KnNVfv