ptero-api v1.0.6

Nodeactyl for V1

Warning: This API is in early stage, do not use it for big servers.

If you're having any issues, join the Discord and ask for support. https://discord.gg/beTDVtD

Installation

npm install ptero-api  

What's already done

Client |Feature|Status | |--|--| | getAccountDetails | :green_circle: | | getAccountPermissions | :green_circle: | | generate2FA | :red_circle: | | enable2FA | :red_circle: | | disable2FA | :red_circle: | | updateEmail | :green_circle: | | updatePassword | :green_circle: | | getApiKeys | :green_circle: | | createApiKey | :green_circle: | | deleteApiKey | :green_circle: | | getAllServers | :green_circle: | | getServerPage | :green_circle: | | getServerDetails | :green_circle: | | getConsoleWebsocket | :green_circle: | | getServerUsages | :green_circle: | | sendServerCommand | :green_circle: | | sendServerCommand | :green_circle: | | startServer | :green_circle: | | stopServer | :green_circle: | | restartServer | :green_circle: | | killServer | :green_circle: | | reinstallServer | :green_circle: | | getDatabases | :red_circle: | | createDatabase | :red_circle: | | rotateDbPassword | :red_circle: | | FILES | :red_circle: | | SCHEDULES/TASKS | :red_circle: | | getSubUsers | :green_circle: | | createSubUser | :green_circle: | | deleteSubUser | :red_circle: | | listServerBackups | :green_circle: | | getBackupDetails | :green_circle: | | getBackupDownload | :green_circle: | | createServerBackup | :green_circle: | | deleteBackup | :green_circle: |

Application (admin) |Feature|Status | |--|--| | getUsers | :green_circle: | | getUserPage | :green_circle: | | getUserDetails | :green_circle: | | getUserByUsername | :green_circle: | | getUserByEmail | :green_circle: | | createUser | :green_circle: | | updateUser | :green_circle: | | deleteUser | :green_circle: | | getAllServers | :green_circle: | | getServerDetails | :green_circle: | | createServer | :green_circle: | | createSimpleServer | :green_circle: | | suspendServer | :green_circle: | | unsuspendServer | :green_circle: | | reinstallServer | :green_circle: | | updateServer | :green_circle: | | updateBuild | :green_circle: | | updateStartup | :red_circle: | | deleteServer | :green_circle: | | NODES | :red_circle: | | LOCATIONS | :red_circle: | | DATABASES | :red_circle: | | NESTS | :red_circle: |

What am I?

Nodeactyl is a Library for node.js to communicated 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 ny node.js project.

Documentation

https://docs.nodeactyl.xyz
The documentation is not updated to the newest version of Nodeactyl.

Disclaimer

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

Remember: This API can potentially be dangerous with the ability to Delete Servers/Nodes at an instant is extremely easy!