Home

Welcome to the pydactyl wiki!

This repo is in heavy development and a wiki will be updated accordingly.

Getting started

In order to use pydactyl in your projects you will need to import it into your code. For this to work you will need a Pterodactyl panel, application API key with read rights.

Download or copy the code from the pydactyl.py file and place it in the project folder you like to use with the name: pydactyl.py.

The following example shows you how to connect and communicate with the API object.

from pydactyl import Application

app = Application(url="https://yourdomain.com", api_key="yourKey")
print(app.get_servers())

First we import the Application class from the pydactyl.py file. After we imported the class we want to pass it our information like our site url and our application api_key. Now that we have our object with the name app we can call the functions within the object. In this example we ask the application to return all the servers on the Pterodactyl panel with app.get_servers(). This returns a JSON/dict object which we can use to extract the information we need.