📌 What am I?

Nodeactyl is a Library for Node.js to communicate with the Pterodactyl Panel. You can control any server on your nodes with it (If you purchase a server from another host, no worry! The API works with your own server too!). This library's originally was to be used in Discord bots, however it can be used in any Node.js project.

❓ How do I work?

This library works by querying the Pterodactyl API (REST requests) using a library called axios.

💻 Getting started with installation

npm i nodeactyl

📖 Documentation

The full docs can be found here

✨ Contributors

Here are the people that make nodeactyl possible and keep the code working!

Would you like to see your GitHub profile picture here?

Simply open a pull request and improve or create code that makes Nodeactyl better!

🚨 Disclaimer

We (The Nodeactyl team & contributors) are not responsible for any damages that you cause to your servers/nodes by using this API.

Remember: This API can potentially be dangerous - it is extremely easy to delete servers/nodes at an instant!

It is NOT our fault if your API key is revealed to the public. When asking for help PLEASE DO NOT SEND THE FULL STACK ERROR. This will reveal your ENTIRE Host/Application API key in the request, if someone asks you to show them the error it should only be trusted sources! (such as the Pterodactyl Team/Nodeactyl Team). You should also have your API key changed every 1-3 days to prevent issues like this.

🧾 License

This project is licensed under the terms of the MIT License.

You can check out the full license here