PHPackages                             timdesm/pterodactyl-php-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. timdesm/pterodactyl-php-api

ActiveLibrary[API Development](/categories/api)

timdesm/pterodactyl-php-api
===========================

Pterodactyl PHP API

v1.3.0(7mo ago)03.9k1MITPHPPHP &gt;=7.2.5

Since Oct 29Pushed 7mo ago1 watchersCompare

[ Source](https://github.com/timdesm/pterodactyl-php-api)[ Packagist](https://packagist.org/packages/timdesm/pterodactyl-php-api)[ RSS](/packages/timdesm-pterodactyl-php-api/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (6)Dependencies (3)Versions (15)Used By (0)

Pterodactyl PHP API
===================

[](#pterodactyl-php-api)

[![Latest Version on Packagist](https://camo.githubusercontent.com/4643932cd83336ff0ab1d76ad6be7f281e19d9359b44c73baf4e531653c31dd0/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f74696d6465736d2f707465726f64616374796c2d7068702d6170692e737667)](https://packagist.org/packages/timdesm/pterodactyl-php-api)[![Total Downloads](https://camo.githubusercontent.com/daf06337959a67bba863e9b30ba47de6d9e300d7102e41974deb5bd9d470784d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f74696d6465736d2f707465726f64616374796c2d7068702d6170692e737667)](https://packagist.org/packages/timdesm/pterodactyl-php-api)[![Software License](https://camo.githubusercontent.com/8bb50fd2278f18fc326bf71f6e88ca8f884f72f179d3e555e20ed30157190d0d/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d677265656e2e737667)](LICENSE.md)[![Chat on Discord](https://camo.githubusercontent.com/d949e3a028209aedbc36b66dee99a88d09ad51dd0c770a4047fcfc1de1504f90/68747470733a2f2f696d672e736869656c64732e696f2f646973636f72642f353936303232383338313936393631333431)](https://discord.gg/VgkQPbG)

**This project is for Pterodactyl Panel v1.x**

[Documentation](https://pterodactyl-api-docs.netvpx.com/docs/intro)

Install Pterodactyl PHP API via Composer
----------------------------------------

[](#install-pterodactyl-php-api-via-composer)

You can install the Pterodactyl PHP API into your project using [Composer](https://getcomposer.org).

```
$ composer require timdesm/pterodactyl-php-api
```

This project requires PHP version `7.2.5` or `later`.

Usage
-----

[](#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);
```

Features
--------

[](#features)

This SDK now mirrors the structure of the [official API surface](https://pterodactyl-api-docs.netvpx.com/docs/intro) and exposes helpers for both Application and Client integrations:

- Full account management including API keys, permissions, activity logs and two factor enable/disable flows.
- Extended server tooling with dedicated managers for backups, databases, files (including chmod, remote pulls, uploads), schedules and subusers.
- Updated HTTP layer with automatic JSON encoding, query filtering and support for every v1 endpoint prefix.

### Examples

[](#examples)

```
// Fetch the current user's API keys
$client = new PterodactylApi('https://panel.example.com', 'client-token', 'client');
$keys = $client->account->apiKeys();

// Schedule a power action on a server
$schedule = $client->server_schedules->create($serverId, [
    'name'        => 'Restart every night',
    'cron_day_of_week' => '*',
    'cron_day_of_month' => '*',
    'cron_hour'   => '3',
    'cron_minute' => '0',
    'is_active'   => true,
]);

$client->server_schedules->createTask($serverId, $schedule->id, [
    'action'     => 'power',
    'payload'    => 'restart',
    'time_offset'=> 0,
]);
```

Some Handy Links
----------------

[](#some-handy-links)

- [Documentation](https://pterodactyl-api-docs.netvpx.com/docs/intro) - The community maintained Pterodactyl API documentation.
- [Pterodactyl](https://pterodactyl.io/) - The Pterodactyl Panel project website.
- [Pterodactyl API v1](https://dashflo.net/docs/api/pterodactyl/v1/) - Pterodactyl API v1 Documentation.

Get Support!
------------

[](#get-support)

First check the [Documentation](https://pterodactyl-api-docs.netvpx.com/docs/intro) 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](https://discord.gg/VgkQPbG) or [submitting new issue](https://github.com/timdesm/pterodactyl-php-api/issues/new).

Contributing
------------

[](#contributing)

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

License
-------

[](#license)

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

###  Health Score

39

—

LowBetter than 86% of packages

Maintenance64

Regular maintenance activity

Popularity20

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~289 days

Recently: every ~361 days

Total

6

Last Release

215d ago

PHP version history (2 changes)1.0.0PHP &gt;=5.6.4

v1.3.0PHP &gt;=7.2.5

### Community

Maintainers

![](https://www.gravatar.com/avatar/9826a90801410dc7ee810a68142db502a57c6184b6a9f315c1b6c8cf4f38eec7?d=identicon)[timdesm](/maintainers/timdesm)

---

Top Contributors

[![timdesm](https://avatars.githubusercontent.com/u/30378686?v=4)](https://github.com/timdesm "timdesm (17 commits)")

---

Tags

phpapipterodactyl

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/timdesm-pterodactyl-php-api/health.svg)

```
[![Health](https://phpackages.com/badges/timdesm-pterodactyl-php-api/health.svg)](https://phpackages.com/packages/timdesm-pterodactyl-php-api)
```

###  Alternatives

[openai-php/laravel

OpenAI PHP for Laravel is a supercharged PHP API client that allows you to interact with the Open AI API

3.7k7.6M74](/packages/openai-php-laravel)[hubspot/api-client

Hubspot API client

23914.2M16](/packages/hubspot-api-client)[theodo-group/llphant

LLPhant is a library to help you build Generative AI applications.

1.5k311.5k5](/packages/theodo-group-llphant)[resend/resend-php

Resend PHP library.

574.7M21](/packages/resend-resend-php)[checkout/checkout-sdk-php

Checkout.com SDK for PHP

553.3M7](/packages/checkout-checkout-sdk-php)[scriptdevelop/whatsapp-manager

Paquete para manejo de WhatsApp Business API en Laravel

762.6k](/packages/scriptdevelop-whatsapp-manager)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
