nodeactyl / nodeactyl

A NodeJS API for Pterodactyl panel, this was originally designed for discord.js (Discord bots)

---

📌 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

nodeactyl's Issues

Logging in looks for error code 404 (Not found) instead of 403 (Not authorized)

panel support

add 1.0 pterodactyl panel support

Help me with this error

Regex Test Emails

Currently any wrong email would return in a 422 error which might be confusing.

Unknow error while trying to create server

Hey, I having an error while create server,

I made

const node = require('nodeactyl');
let app = node.Application;

app.login(url, key, (logged_in, err) => {
    console.log(logged_in);
    app.createServer("latest", "test", 26, 7, 17, "quay.io/parkervcp/pterodactyl-images:debian_nodejs-12", "npm install", 512, 0, 200, 500, 100, 0, 1).then(res => {
        console.log(res)
    }).catch(error =>{
        console.log(error);
    })
});

But in console I recieved

node main.js
NODEACTYL WARNING: There has been a COMPLETE rewrite of Nodeactyl, Please review our new documentation at: https://nodeactyl.ell
iotfrost.xyz/v/v2.0.0-english/ Alternativly if you need further assistance ask for help in our discord server: https://discordap
p.com/invite/3e5uJPt
true
undefined

it's normal to return undefined ?

Assign additional allocations

How it is possible to assign additional allocation to the specific server with this package

TODO/Feature Request: Slice "/" At the end of a URL if it exists

Automatically trim the "/" character on a URL if it exists on a URL (This "/" at the end of a URL screws wth API endpoints)

API Endpoint to consume console log

Just as the API console which can be accessed thru the deamon (pterodactyl/panel#586).

Status not updating

When I send a power action to a server, and I try to fetch the resource usage and status, it's not updating.

For example: I send the kill action to a server. On the panel, I can see it's killed, but in my NodeJS application it's not updating. It's already in a setTimeout to give the server time to stop.

Who can help me with this?

TypeError: Cannot read property 'status' of undefined

Hi there,
I am facing the issue #7 now also, how to fix it ?

Proof It's Me

Hey Jelly,
It's me alhassan#5471 827614989892059247

sendCommand() cant catch errors

will put more on this soon

callback is not a function

Hey guys,
Callback is not a function on nodeactyl/client/index.js:48:4. might wanna ehmm? idk help me?

422 error

I keep getting a 422 (Unprocessable Entity) error whenever attempting to create a server. Here's my code:

router.get("/newserver", checkAuth, async function(req, res) {
    let pteroData = await client.getUserByEmail(req.user.email)
    let server = new Nodeactyl.ServerBuilder()
    server.setServerName(req.query.name)
    server.setServerOwner(pteroData.attributes.id)
    server.setServerEgg(parseInt(req.query.egg))
    server.setServerLimitsJson(JSON.stringify({
        "ram": parseInt(req.query.ram),
        "disk": parseInt(req.query.disk),
        "cpu": parseInt(req.query.cpu),
        "swap": 0
    }))
    let JSONobject = await server.getServerObject()
    console.log(JSONobject)
    client.createRawServer(JSONobject)
    res.redirect("/shop")
})

getServerDetails doesnt return ports/Allocations

both Client and application don't return a port in the attributes when running getServerDetails()

Package not seeming to install right

It seems that the nodeactyl cant be installed normally. it can only be installed by typing npm init into your main user folder (C:\Users\User) after proceeding to generate a package.json file in that directory it seems to fix the issue, anyone know why this is?

Unsuspending servers not working

Code:
Application.login('HOST', 'API_KEY', (logged_in, err) => { Application.unSuspendServer("2").then(server => { console.log(server) }).catch(err => { console.log(err); }) });

logged_in return true
server returns Server unsuspended successfully
After that server still suspended

Im sure server internalid is valid

Update:
Seems like the panel was rate limiting me somehow, my request didnt go through, works fine now though.

Unhandled error code 422 when using "createServer" [Nodeactyl V2]

When creating 2nd server on the same user, and you use the same ID/Name (Not sure yet) that already exists for creating a server the error code comes up "422" and leads to a runtime error/crash. This is not top priority but this issue is here for my personal checklist.

Add an option in createServer to allow people to specify an environment variable

add an option to send a version variables like so:

Application#createServer(args, args. . . , { "VERSION": "1.15" });

Not sure how /api/client/servers/UUID/startup/* works

Not really sure what this is meant for but if anyone cares to explain and or add in these methods feel free to do so, until then consider this endpoint one of the last ones to be added

Docs Website Down

The docs website is down just now, can someone fix it?
https://docs.nodeactyl.xyz/

README typo

The word "axios" is misspelled in the README file.

getAllUsers does not show all users

getAllUsers limited to 51 users and is not displaying all users. Looks like 51 users are a full page on admin/users?page=1

TypeError: Cannot read property 'status' of undefined

(node:6160) UnhandledPromiseRejectionWarning: TypeError: Cannot read property 'status' of undefined
    at throwErrors (D:\DiscordBots\Modulohost\node_modules\nodeactyl\Nodeactyl.js:20:31)
    at axios.then.catch.error (D:\DiscordBots\Modulohost\node_modules\nodeactyl\Nodeactyl.js:526:9)
    at process.internalTickCallback (internal/process/next_tick.js:77:7)
(node:6160) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 1)
(node:6160) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

This is the error I get when I attempt to use <Client>.createUser etc

dont steal packages

createUser does not throw UserAlreadyCreated error

Just need to add status code != 201 and its good to go (V2 Update)

Create server function not doing anything

I login, and do everything right. But when I call it, nothing happens, and I entered in all of the info correctly. The createUser works too, so it is just the createServer function.

Issue

application
  .createUser("email", "aydn", "Halil", "Aydın")
  .then((res) => {
    console.log(res);
  })
  .catch((rej) => {
    console.log(rej);
  });

it doesnt create new user and returns already existing users it happens also when i want to create new server

When making a user it always throws user already created

Every time a new user is created with createUser it says User already exists error 422 even if I set the info to cjdjrifnnfjsjdj and I always verify the account doesn’t exist

Are there types for this project.

It's pretty straight forward. Are there ts types for the project?

Make ServerBuilder return this for methods

Uhh.. the title, pretty self explanatory

dont steal packages asshole :)

package stealer lmao

createServer returns undefined

I can't create a server,
It returns undefined
and all parameters are good
application.Application.createServer("latest", NodeJs, uss /* User Id */ , 5, 16,"dockerImage", "Cmd", 200,0, 1000, 500, 0, 5, 1)

403 Error while getAllServer

I use heroku and cause this problem