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

Maintained by NETVPX and shared freely with the Pterodactyl community. This comprehensive documentation covers all API endpoints with multi-language examples, interactive testing, and detailed implementation guides.

📖 View Live Documentation →

This is the most comprehensive Pterodactyl API documentation available, featuring detailed coverage of all Pterodactyl Panel v1.0+ endpoints with production-ready examples.

• 👥 Client API (18 endpoints) - End-user server management, files, databases, backups, scheduling
• 🔧 Application API (15+ endpoints) - Administrative panel management, users, nodes, servers
• 🔌 WebSocket API (5 endpoints) - Real-time console access, server statistics, live monitoring

• 💯 Production-Tested: All 38 endpoints tested against live Pterodactyl installations
• 🌍 Multi-Language: Code examples in 8 programming languages for every endpoint
• 🔄 Always Updated: Continuously verified against Pterodactyl's latest development branch
• 🚪 Open Source: Community-driven with easy contribution workflow

• Modern Stack: Built with Docusaurus 3 + TypeScript
• Version Switcher: Support for multiple API versions (v1.0+ current, v0.7 legacy)
• Responsive Design: Perfect experience on desktop, tablet, and mobile
• Instant Search: Fast local search with auto-complete
• Interactive Examples: Tabbed code samples with copy-to-clipboard
• Live Testing: Every endpoint verified against real Pterodactyl panels

8 Programming Languages for every API endpoint:

• 📝 cURL - Command line HTTP client
• 🟡 JavaScript - Node.js and browser examples
• 🐍 Python - Using requests library
• 🐘 PHP - cURL and Guzzle implementations
• 🔵 Go - Native HTTP client
• ☕ Java - OkHttp library
• 🔷 C# - HttpClient implementation
• 🔴 Ruby - Net::HTTP examples

• 38/38 Tests Passing: Complete endpoint coverage
• Live API Validation: Tests run against actual Pterodactyl installations
• Multiple Test Modes: Safe (read-only), partial, and full destructive testing
• Automated Cleanup: Test resources automatically cleaned up
• CI/CD Integration: GitHub Actions with comprehensive reporting

• Fork-First Workflow: Clear contribution guidelines
• Issue Templates: Bug reports and feature requests
• PR Templates: Structured review process
• Active Maintenance: Regular updates and community support
• 💬 Community Discussion: Integrated Giscus commenting system for documentation feedback

🌐 View Online: pterodactyl-api-docs.netvpx.com

📝 Quick API Reference:

• Client API Overview - User server management
• Application API Overview - Admin panel management
• WebSocket API - Real-time console access
• Authentication Guide - API keys and security

Prerequisites:

• Node.js 20.0+ (recommended: use nvm)
• npm or yarn package manager

# 1. Fork the repository on GitHub first!
# 2. Clone your fork
git clone https://github.com/YOUR_USERNAME/pterodactyl-api-docs.git
cd pterodactyl-api-docs

# 3. Install dependencies
npm install

# 4. Start development server
npm start
# → Opens http://localhost:3000

# 5. Build for production
npm run build
# → Generates static files in build/ directory

# 1. Copy test configuration
cp .env.test.example .env.test

# 2. Configure your Pterodactyl panel details
nano .env.test

# 3. Run comprehensive API tests
cd tests && npm test
# → Tests all 38 endpoints with detailed reporting

38/38 endpoints tested against live Pterodactyl installations with detailed validation:

• 🔥 Live API Validation: Tests against real Pterodactyl panels
• 🛡️ Safe Mode: Read-only tests for production environments
• 🔄 Auto Cleanup: Test resources automatically cleaned up
• 📊 Performance Metrics: Response time monitoring
• 📝 Detailed Logging: Full request/response analysis
• 🐛 Schema Validation: Ensures API responses match documented formats

# Quick test run (safe mode - read only)
npm test -- --testNamePattern="list"

# Full destructive test suite
SAFE_MODE=false npm test

# Test specific endpoints
npm test -- --testNamePattern="servers"

GitHub Actions automatically:

• ✅ Build documentation on every commit
• 🧪 Run test suite on pull requests
• 📊 Generate coverage reports
• 🛡️ Scan for security vulnerabilities
• 🚀 Deploy to production on main branch

├── docs/                   # Documentation content
│   ├── intro.md           # Introduction page
│   ├── authentication.md  # Authentication guide
│   ├── rate-limiting.md   # Rate limiting information
│   ├── error-handling.md  # Error handling guide
│   ├── contributing.md    # Contribution guidelines (within docs)
│   └── api/               # API documentation
│       ├── client/        # Client API endpoints
│       ├── application/   # Application API endpoints
│       └── websocket.md   # WebSocket API documentation
├── tests/                 # Enhanced API testing suite
├── static/                # Static assets (images, favicons, etc.)
├── src/                   # React components and styling
├── .github/               # GitHub templates and workflows
│   ├── ISSUE_TEMPLATE/    # Bug report and improvement templates
│   ├── workflows/         # GitHub Actions (build.yml)
│   └── pull_request_template.md
├── docusaurus.config.ts   # Docusaurus configuration
├── sidebars.ts           # Sidebar configuration
├── CONTRIBUTING.md        # Contribution guidelines
├── LICENSE               # MIT License
└── package.json          # Dependencies and scripts

All API endpoints include examples in 8 programming languages:

• cURL - Command line HTTP client
• JavaScript - Node.js and browser examples
• Python - Using requests library
• PHP - Using cURL and Guzzle
• Go - Native HTTP client
• Java - Using OkHttp
• C# - Using HttpClient
• Ruby - Using Net::HTTP

Examples are presented in an interactive tabbed interface for easy language switching.

• Account management and authentication
• Server power controls and resource monitoring
• File management and operations
• Database creation and management
• Scheduled task automation
• Network allocation management
• User permissions and subuser management
• Backup management

• User administration
• Server creation and management
• Node and location management
• Nest and egg configuration
• System-wide settings

• Real-time server console access
• Live server statistics
• Event-based communication

We welcome contributions from the community! This project is open source and we encourage developers to help improve the documentation.

For small fixes:

1. Click "Edit this page" on any documentation page
2. Make your changes in GitHub
3. Submit a pull request

For significant changes:

1. Read our Contributing Guidelines
2. Check out our documentation contribution guide
3. Fork the repository
4. Create a feature branch
5. Make your changes and test locally
6. Submit a pull request using our template

• 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

• GitHub Actions automatically build and test documentation
• Pull Request Templates ensure quality contributions
• Issue Templates for bug reports and improvements
• Local Testing with comprehensive API test suite

For support with this documentation:

• GitHub Issues: Report bugs or request improvements
• GitHub Discussions: Ask questions and share ideas
• NETVPX Support: https://netvpx.com/support
• Pterodactyl Community: Discord

• Pterodactyl Panel: https://pterodactyl.io/
• Pterodactyl GitHub: https://github.com/pterodactyl/panel
• NETVPX: https://netvpx.com/
• Docusaurus: https://docusaurus.io/

Special thanks to all contributors who help make this documentation better for the Pterodactyl community!

This documentation is licensed under the MIT License. See the LICENSE file for details.

The Pterodactyl Panel software is licensed under the MIT License by the Pterodactyl Software team.

Maintained with ❤️ by NETVPX and shared freely with the Pterodactyl community.