Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:

strategy:
matrix:
node-version: [20.x]
node-version: [24.x]

steps:
- name: Checkout repository
Expand Down Expand Up @@ -44,7 +44,7 @@ jobs:
echo "Build successful!"

- name: Upload build artifacts
if: matrix.node-version == '20.x' && github.event_name == 'push'
if: matrix.node-version == '24.x' && github.event_name == 'push'
uses: actions/upload-artifact@v4
with:
name: documentation-build
Expand All @@ -62,7 +62,7 @@ jobs:
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20.x'
node-version: '24.x'
cache: 'npm'

- name: Install dependencies
Expand All @@ -81,4 +81,4 @@ jobs:
exit 1
else
echo "✅ No broken links found!"
fi
fi
1 change: 1 addition & 0 deletions .node-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
24.18.1
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
24.18.1
17 changes: 8 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Contributing to NETVPX Pterodactyl API Documentation
# Contributing to Pterodactyl API Documentation

Thank you for your interest in contributing to the Pterodactyl API documentation! This project is maintained by NETVPX and shared freely with the community to help developers succeed with their Pterodactyl implementations.
Thank you for your interest in contributing to the Pterodactyl API documentation. This project is shared freely with the community to help developers succeed with their Pterodactyl implementations.

## 🎯 How to Contribute

### 1. Reporting Issues

- **Bug Reports**: Found an error in the documentation? Please [create an issue](https://github.com/netvpx/pterodactyl-api-docs/issues/new) with:
- **Bug Reports**: Found an error in the documentation? Please [create an issue](https://github.com/AjdinDev/pterodactyl-api-docs/issues/new) with:
- Clear description of the problem
- Steps to reproduce (if applicable)
- Expected vs actual behavior
Expand All @@ -25,7 +25,7 @@ For changes or new content:

1. **Fork the repository**
```bash
git clone https://github.com/netvpx/pterodactyl-api-docs.git
git clone https://github.com/AjdinDev/pterodactyl-api-docs.git
cd pterodactyl-api-docs
npm install
```
Expand Down Expand Up @@ -104,7 +104,7 @@ When adding or updating code examples:
## 🔧 Development Setup

### Prerequisites
- Node.js 20.0+
- Node.js 24 LTS
- npm or yarn

### Local Development
Expand Down Expand Up @@ -156,9 +156,8 @@ Each endpoint should include:
## 🤝 Community

### Getting Help
- **Questions**: Use [GitHub Discussions](https://github.com/netvpx/pterodactyl-api-docs/discussions)
- **Pterodactyl Chat**: Join the [Pterodactyl Discord](https://discord.gg/pterodactyl) which has a [dedicated API & Modding channel](https://discord.com/channels/122900397965705216/936744899787784282)
- **NETVPX Support**: [Contact us](https://netvpx.com/support) for other questionst
- **Questions**: Use [GitHub Discussions](https://github.com/AjdinDev/pterodactyl-api-docs/discussions)
- **Documentation Issues**: Use [GitHub Issues](https://github.com/AjdinDev/pterodactyl-api-docs/issues) for bugs, unclear pages, and missing examples.

## 🚀 Release Process

Expand All @@ -172,4 +171,4 @@ By contributing, you agree that your contributions will be licensed under the MI

**Thank you for helping make Pterodactyl API documentation better for everyone! 🎉**

*This project is maintained by [NETVPX](https://netvpx.com) and shared freely with the Pterodactyl community.*
*This project is shared freely with the Pterodactyl community.*
4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2025 NETVPX
Copyright (c) 2026 PteroAPI contributors
Comment thread
AjdinDev marked this conversation as resolved.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand All @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
35 changes: 16 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# 🚀 Pterodactyl API Documentation

[![Build Status](https://img.shields.io/github/actions/workflow/status/netvpx/pterodactyl-api-docs/build.yml?branch=main&style=flat-square)](https://github.com/netvpx/pterodactyl-api-docs/actions)
[![Documentation](https://img.shields.io/badge/docs-live-blue?style=flat-square)](https://pterodactyl-api-docs.netvpx.com)
[![Build Status](https://img.shields.io/github/actions/workflow/status/AjdinDev/pterodactyl-api-docs/build.yml?branch=main&style=flat-square)](https://github.com/AjdinDev/pterodactyl-api-docs/actions)
[![Documentation](https://img.shields.io/badge/docs-live-blue?style=flat-square)](https://pteroapi.com)
[![API Tests](https://img.shields.io/badge/API%20tests-38%2F38%20passing-green?style=flat-square)](#api-testing)
[![Contributors](https://img.shields.io/github/contributors/netvpx/pterodactyl-api-docs?style=flat-square)](https://github.com/netvpx/pterodactyl-api-docs/graphs/contributors)
[![Contributors](https://img.shields.io/github/contributors/AjdinDev/pterodactyl-api-docs?style=flat-square)](https://github.com/AjdinDev/pterodactyl-api-docs/graphs/contributors)
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)

**Complete API documentation and testing suite for Pterodactyl Panel v1.0+**

Maintained by [NETVPX](https://netvpx.com) and shared freely with the Pterodactyl community. This comprehensive documentation covers all API endpoints with multi-language examples, interactive testing, and detailed implementation guides.
Shared freely with the Pterodactyl community, PteroAPI provides comprehensive documentation for API endpoints with multi-language examples, interactive testing, and detailed implementation guides.

📖 **[View Live Documentation →](https://pterodactyl-api-docs.netvpx.com)**
📖 **[View Live Documentation →](https://pteroapi.com)**

## 🎯 About This Project

Expand Down Expand Up @@ -68,18 +68,18 @@ This is the **most comprehensive Pterodactyl API documentation** available, feat

### 🔍 Using the Documentation

**🌐 View Online**: [pterodactyl-api-docs.netvpx.com](https://pterodactyl-api-docs.netvpx.com)
**🌐 View Online**: [pteroapi.com](https://pteroapi.com)

**📝 Quick API Reference**:
- [Client API Overview](https://pterodactyl-api-docs.netvpx.com/docs/api/client) - User server management
- [Application API Overview](https://pterodactyl-api-docs.netvpx.com/docs/api/application) - Admin panel management
- [WebSocket API](https://pterodactyl-api-docs.netvpx.com/docs/api/websocket) - Real-time console access
- [Authentication Guide](https://pterodactyl-api-docs.netvpx.com/docs/authentication) - API keys and security
- [Client API Overview](https://pteroapi.com/docs/api/client) - User server management
- [Application API Overview](https://pteroapi.com/docs/api/application) - Admin panel management
- [WebSocket API](https://pteroapi.com/docs/api/websocket) - Real-time console access
- [Authentication Guide](https://pteroapi.com/docs/authentication) - API keys and security

### 💻 Local Development

**Prerequisites:**
- Node.js 20.0+ (recommended: use [nvm](https://github.com/nvm-sh/nvm))
- Node.js 24 LTS (recommended: use [nvm](https://github.com/nvm-sh/nvm))
- npm or yarn package manager

```bash
Expand Down Expand Up @@ -238,7 +238,7 @@ For small fixes:

For significant changes:
1. Read our [Contributing Guidelines](CONTRIBUTING.md)
2. Check out our [documentation contribution guide](https://pterodactyl-api-docs.netvpx.com/docs/contributing)
2. Check out our [documentation contribution guide](https://pteroapi.com/docs/contributing)
3. Fork the repository
4. Create a feature branch
5. Make your changes and test locally
Expand All @@ -249,7 +249,7 @@ For significant changes:
- All code examples must be tested and working
- Follow the established multi-language format
- Use CodeTabs component for code examples
- Maintain NETVPX branding and style consistency
- Match the existing documentation style and structure

## Automated Testing & CI/CD

Expand All @@ -262,16 +262,13 @@ For significant changes:

For support with this documentation:

- **GitHub Issues**: [Report bugs or request improvements](https://github.com/netvpx/pterodactyl-api-docs/issues)
- **GitHub Discussions**: [Ask questions and share ideas](https://github.com/netvpx/pterodactyl-api-docs/discussions)
- **NETVPX Support**: [https://netvpx.com/support](https://netvpx.com/support)
- **Pterodactyl Community**: [Discord](https://discord.gg/pterodactyl)
- **GitHub Issues**: [Report bugs or request improvements](https://github.com/AjdinDev/pterodactyl-api-docs/issues)
- **GitHub Discussions**: [Ask questions and share ideas](https://github.com/AjdinDev/pterodactyl-api-docs/discussions)

## Related Links

- **Pterodactyl Panel**: [https://pterodactyl.io/](https://pterodactyl.io/)
- **Pterodactyl GitHub**: [https://github.com/pterodactyl/panel](https://github.com/pterodactyl/panel)
- **NETVPX**: [https://netvpx.com/](https://netvpx.com/)
- **Docusaurus**: [https://docusaurus.io/](https://docusaurus.io/)

## Recognition
Expand All @@ -286,4 +283,4 @@ The Pterodactyl Panel software is licensed under the MIT License by the Pterodac

---

**Maintained with ❤️ by [NETVPX](https://netvpx.com) and shared freely with the Pterodactyl community.**
**Shared freely with the Pterodactyl community.**
4 changes: 2 additions & 2 deletions docs/api/application/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ keywords:
- node management
- location management
- administrative endpoints
image: /img/netvpx-social-card.jpg
image: /img/pteroapi-social-card.jpg
---

# Application API
Expand Down Expand Up @@ -195,4 +195,4 @@ For detailed source code references, see our [Source References Guide](/docs/sou
- Start with [User Management](/docs/api/application/users) for basic administrative operations
- Explore [Server Management](/docs/api/application/servers) for automated deployments
- Configure [Node Management](/docs/api/application/nodes) for infrastructure scaling
- Review [Authentication](/docs/authentication) for security best practices
- Review [Authentication](/docs/authentication) for security best practices
4 changes: 2 additions & 2 deletions docs/api/client/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ keywords:
- pterodactyl panel client
- server control endpoints
- hosting api
image: /img/netvpx-social-card.jpg
image: /img/pteroapi-social-card.jpg
---

# Client API
Expand Down Expand Up @@ -224,4 +224,4 @@ For detailed source code references, see our [Source References Guide](/docs/sou

- Start with [Account Management](/docs/api/client/account) to test your API key
- Explore [Server Management](/docs/api/client/servers) for basic server operations
- Review [Authentication](/docs/authentication) for security best practices
- Review [Authentication](/docs/authentication) for security best practices
4 changes: 2 additions & 2 deletions docs/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ keywords:
- pterodactyl panel api keys
- api token generation
- secure api access
image: /img/netvpx-social-card.jpg
image: /img/pteroapi-social-card.jpg
---

# Authentication
Expand Down Expand Up @@ -132,4 +132,4 @@ Pterodactyl API keys follow this naming pattern:

- Review [Rate Limiting](./rate-limiting) information
- Explore the [Client API](./api/client) documentation
- Check out the [Application API](./api/application) documentation (Coming Soon)
- Check out the [Application API](./api/application) documentation (Coming Soon)
8 changes: 3 additions & 5 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
sidebar_position: 8
title: Contributing to Documentation
description: Learn how to contribute to the NETVPX Pterodactyl API documentation
description: Learn how to contribute to the Pterodactyl API documentation
keywords: [contributing, documentation, pterodactyl api, open source, collaboration]
---

Expand Down Expand Up @@ -198,7 +198,7 @@ curl -X GET "https://example.com/api/endpoint"
- Be respectful and constructive
- Help others learn and grow
- Focus on improving the documentation
- Maintain NETVPX branding consistency
- Match the existing documentation style and structure

## 🔧 Development Tools

Expand Down Expand Up @@ -239,14 +239,12 @@ Contributors are recognized in several ways:
Need assistance with your contribution?

- **GitHub Discussions**: Ask questions and get help
- **Discord**: Join the Pterodactyl community chat
- **Documentation Issues**: Report bugs or unclear instructions
- **NETVPX Support**: Contact for hosting-related questions

## 🎉 Thank You!

Every contribution, no matter how small, helps make the Pterodactyl API documentation better for developers worldwide. Thank you for being part of our community!

---

*For detailed technical contribution guidelines, see our [CONTRIBUTING.md](https://github.com/netvpx/pterodactyl-api-docs/blob/main/CONTRIBUTING.md) file.*
*For detailed technical contribution guidelines, see our [CONTRIBUTING.md](https://github.com/AjdinDev/pterodactyl-api-docs/blob/main/CONTRIBUTING.md) file.*
18 changes: 6 additions & 12 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,19 @@ description: Complete API documentation for Pterodactyl Panel v1. Learn how to i
keywords: [pterodactyl, api, documentation, server management, rest api, websocket, automation]
---

<!-- Force Cloudflare deployment refresh - OpenAPI plugin removed -->

# Pterodactyl Panel API Documentation

Welcome to the **NETVPX Pterodactyl v1 API documentation**. This documentation provides comprehensive information about the Pterodactyl Panel API, allowing you to programmatically manage servers, users, files, and more.
Welcome to the **Pterodactyl v1 API documentation**. This documentation provides comprehensive information about the Pterodactyl Panel API, allowing you to programmatically manage servers, users, files, and more.

## About Pterodactyl

Pterodactyl is a free, open-source server management panel built with PHP, React, and Go. Designed with security in mind, Pterodactyl runs everything in Docker containers while exposing a beautiful and intuitive UI to administrators and users.

## About This Documentation

This documentation is maintained by NETVPX out of good will for the Pterodactyl community. We believe in contributing to open-source projects and helping developers succeed with their implementations.

You won't find any ads, tracking (except for a cookieless analytics tool), or aggressive marketing throughout these docs. Just clean, comprehensive documentation focused on helping you build amazing applications with the Pterodactyl API.
This documentation is maintained as an independent community resource for Pterodactyl API users. We believe in contributing to open-source projects and helping developers succeed with their implementations.

If you're looking for hosting solutions for your Pterodactyl panel, feel free to check out [NETVPX hosting services](https://netvpx.com). We offer reliable infrastructure that we use to test and validate all the examples in this documentation.
You won't find ads, tracking, hosting pitches, or aggressive marketing throughout these docs. Just clean, comprehensive documentation focused on helping you build applications with the Pterodactyl API.


## Usage of AI
Expand Down Expand Up @@ -76,7 +72,7 @@ We welcome contributions from the community! Help improve this documentation for

- **Quick Edits**: Click "Edit this page" on any documentation page
- **Major Improvements**: Fork the repository and submit pull requests
- **Report Issues**: Found an error? [Create a GitHub Issue](https://github.com/netvpx/pterodactyl-api-docs/issues/new)
- **Report Issues**: Found an error? [Create a GitHub Issue](https://github.com/AjdinDev/pterodactyl-api-docs/issues/new)
- **Code Examples**: Help add or improve multi-language examples

👉 **[Read our Contributing Guide](/docs/contributing)** for detailed instructions on how to contribute.
Expand All @@ -92,11 +88,9 @@ Your feedback helps us make this documentation better for everyone in the commun

If you encounter any issues with this documentation or the Pterodactyl API, here are some helpful resources:

- Visit the [Pterodactyl Discord](https://discord.gg/pterodactyl)
- Check the [Pterodactyl GitHub](https://github.com/pterodactyl/panel)
- Visit the NETVPX [Discord](https://netvpx.com/discord)
- Contact [NETVPX Support](https://netvpx.com/support)
- Open a [documentation issue](https://github.com/AjdinDev/pterodactyl-api-docs/issues) for problems with these docs

---

**Pterodactyl Links:** [Website](https://pterodactyl.io/) | [GitHub](https://github.com/pterodactyl) | [Discord](https://discord.gg/pterodactyl)
**Pterodactyl Links:** [Website](https://pterodactyl.io/) | [GitHub](https://github.com/pterodactyl)
5 changes: 2 additions & 3 deletions docs/source-references.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ keywords:
- controller methods
- route definitions
- service classes
image: /img/netvpx-social-card.jpg
image: /img/pteroapi-social-card.jpg
---

# Source Code References
Expand Down Expand Up @@ -141,7 +141,6 @@ If you find issues or want to improve the Panel:

1. **Report Issues**: [Panel Issues](https://github.com/pterodactyl/panel/issues)
2. **Submit Pull Requests**: [Contributing Guide](https://github.com/pterodactyl/panel/blob/1.0-develop/CONTRIBUTING.md)
3. **Join Discord**: [Pterodactyl Community](https://discord.gg/pterodactyl)

### 📚 **Development Setup**

Expand Down Expand Up @@ -171,4 +170,4 @@ All source references in this documentation point to:
- **[Error Handling](./error-handling)** - Common errors and solutions
- **[Client API](./api/client)** - User-facing endpoints
- **[Application API](./api/application)** - Administrative endpoints
- **[WebSocket API](./api/websocket)** - Real-time communication
- **[WebSocket API](./api/websocket)** - Real-time communication
Loading
Loading