https://github.com/maybeizen/pterolink
A Node.js library for interacting with the Pterodactyl Panel API.
https://github.com/maybeizen/pterolink
api pterodactyl pterojs
Last synced: 10 months ago
JSON representation
A Node.js library for interacting with the Pterodactyl Panel API.
- Host: GitHub
- URL: https://github.com/maybeizen/pterolink
- Owner: maybeizen
- License: mit
- Created: 2025-01-01T19:24:17.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-13T02:54:09.000Z (over 1 year ago)
- Last Synced: 2025-02-13T03:28:48.241Z (over 1 year ago)
- Topics: api, pterodactyl, pterojs
- Language: JavaScript
- Homepage:
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PteroLink
A Node.js library for interacting with the Pterodactyl Panel API.
## Installation
```bash
# still in development lol
```
## Getting Started
### Communicating with the Application API
```js
const { ApplicationClient } = require("pterolink");
const client = new ApplicationClient({
url: "https://your-pterodactyl-panel.com",
apiKey: "your-api-key", // Application API Key (from Admin Control Panel)
});
```
### Communicating with the Client API
```js
const { UserClient } = require("pterolink");
const client = new UserClient({
url: "https://your-pterodactyl-panel.com",
apiKey: "your-api-key", // User-Specific API Key
});
```
## Contributing
If you want to contribute to this project, please feel free to submit a pull request.
## License
This project is licensed under the MIT License - see the LICENSE file for details.