PterodactylPanelApi Plugin A comprehensive Pterodactyl Panel API implementation for FeatherPanel that provides full compatibility with Pterodactyl's Application API endpoints.
All endpoints require a valid API key to be provided in the Authorization header as a Bearer token.
Endpoint
Method
Description
Auth Required
Example Path
/api/application/usersGET
List all users
Yes (API Key)
/api/application/users
/api/application/users/{user}GET
View user by ID
Yes (API Key)
/api/application/users/42
/api/application/users/external/{external_id}GET
View user by external ID
Yes (API Key)
/api/application/users/external/abc123
/api/application/usersPOST
Create a new user
Yes (API Key)
/api/application/users
/api/application/users/{user}PATCH
Update an existing user by ID
Yes (API Key)
/api/application/users/42
/api/application/users/{user}DELETE
Delete a user by ID
Yes (API Key)
/api/application/users/42
Endpoint
Method
Description
Auth Required
Example Path
/api/application/serversGET
List all servers
Yes (API Key)
/api/application/servers
/api/application/serversPOST
Create a new server
Yes (API Key)
/api/application/servers
/api/application/servers/{server}GET
Get server details by ID
Yes (API Key)
/api/application/servers/42
/api/application/servers/external/{external_id}GET
Get server details by external ID
Yes (API Key)
/api/application/servers/external/abc123
/api/application/servers/{server}/suspendPOST
Suspend a server
Yes (API Key)
/api/application/servers/42/suspend
/api/application/servers/{server}/unsuspendPOST
Unsuspend a server
Yes (API Key)
/api/application/servers/42/unsuspend
/api/application/servers/{server}/reinstallPOST
Reinstall a server
Yes (API Key)
/api/application/servers/42/reinstall
/api/application/servers/{server}DELETE
Delete a server
Yes (API Key)
/api/application/servers/42
/api/application/servers/{server}/detailsPATCH
Update server details
Yes (API Key)
/api/application/servers/42/details
/api/application/servers/{server}/buildPATCH
Update server build configuration
Yes (API Key)
/api/application/servers/42/build
/api/application/servers/{server}/startupPATCH
Update server startup configuration
Yes (API Key)
/api/application/servers/42/startup
Endpoint
Method
Description
Auth Required
Example Path
/api/application/locationsGET
List all locations
Yes (API Key)
/api/application/locations
/api/application/locations/{locationId}GET
Get location details
Yes (API Key)
/api/application/locations/1
/api/application/locationsPOST
Create a new location
Yes (API Key)
/api/application/locations
/api/application/locations/{locationId}PATCH
Update location details
Yes (API Key)
/api/application/locations/1
/api/application/locations/{locationId}DELETE
Delete a location
Yes (API Key)
/api/application/locations/1
Endpoint
Method
Description
Auth Required
Example Path
/api/application/nodesGET
List all nodes
Yes (API Key)
/api/application/nodes
/api/application/nodes/{nodeId}GET
Get node details
Yes (API Key)
/api/application/nodes/1
/api/application/nodes/deployableGET
Get deployable nodes
Yes (API Key)
/api/application/nodes/deployable
/api/application/nodesPOST
Create a new node
Yes (API Key)
/api/application/nodes
/api/application/nodes/{nodeId}PATCH
Update node configuration
Yes (API Key)
/api/application/nodes/1
/api/application/nodes/{nodeId}DELETE
Delete a node
Yes (API Key)
/api/application/nodes/1
/api/application/nodes/{nodeId}/configurationGET
Get node Wings configuration
Yes (API Key)
/api/application/nodes/1/configuration
/api/application/nodes/{nodeId}/allocationsGET
List node allocations
Yes (API Key)
/api/application/nodes/1/allocations
/api/application/nodes/{nodeId}/allocationsPOST
Create node allocations
Yes (API Key)
/api/application/nodes/1/allocations
/api/application/nodes/{nodeId}/allocations/{allocationId}DELETE
Delete node allocation
Yes (API Key)
/api/application/nodes/1/allocations/5
Endpoint
Method
Description
Auth Required
Example Path
/api/application/nestsGET
List all nests
Yes (API Key)
/api/application/nests
/api/application/nests/{nestId}GET
Get nest details
Yes (API Key)
/api/application/nests/1
/api/application/nests/{nestId}/eggsGET
List nest eggs
Yes (API Key)
/api/application/nests/1/eggs
/api/application/nests/{nestId}/eggs/{eggId}GET
Get egg details
Yes (API Key)
/api/application/nests/1/eggs/5
Endpoint
Method
Description
Auth Required
Example Path
/api/application/servers/{serverId}/databasesGET
List server databases
Yes (API Key)
/api/application/servers/42/databases
/api/application/servers/{serverId}/databases/{databaseId}GET
Get database details
Yes (API Key)
/api/application/servers/42/databases/1
/api/application/servers/{serverId}/databasesPOST
Create server database
Yes (API Key)
/api/application/servers/42/databases
/api/application/servers/{serverId}/databases/{databaseId}PATCH
Update database
Yes (API Key)
/api/application/servers/42/databases/1
/api/application/servers/{serverId}/databases/{databaseId}/reset-passwordPOST
Reset database password
Yes (API Key)
/api/application/servers/42/databases/1/reset-password
/api/application/servers/{serverId}/databases/{databaseId}DELETE
Delete database
Yes (API Key)
/api/application/servers/42/databases/1
🔑 Admin API Key Management
Endpoint
Method
Description
Auth Required
Example Path
/api/pterodactylpanelapi/api-keysGET
List all API keys
Yes (Admin)
/api/pterodactylpanelapi/api-keys
/api/pterodactylpanelapi/api-keys/{id}GET
Get API key details
Yes (Admin)
/api/pterodactylpanelapi/api-keys/1
/api/pterodactylpanelapi/api-keysPOST
Create new API key
Yes (Admin)
/api/pterodactylpanelapi/api-keys
/api/pterodactylpanelapi/api-keys/{id}PUT/PATCH
Update API key
Yes (Admin)
/api/pterodactylpanelapi/api-keys/1
/api/pterodactylpanelapi/api-keys/{id}DELETE
Delete API key
Yes (Admin)
/api/pterodactylpanelapi/api-keys/1
Endpoint
Method
Description
Auth Required
Example Path
/api/pterodactylpanelapi-settingsGET
Get plugin settings
Yes (Admin)
/api/pterodactylpanelapi-settings
🧑💻 Client API (Pterodactyl-Compatible)
Endpoint
Method
Description
Auth Required
Example Path
/api/client/accountGET
Get account details
Yes (Client)
/api/client/account
/api/client/account/emailPUT
Update account email
Yes (Client)
/api/client/account/email
/api/client/account/passwordPUT
Update account password
Yes (Client)
/api/client/account/password
/api/client/permissionsGET
List available permissions
Yes (Client)
/api/client/permissions
Endpoint
Method
Description
Auth Required
Example Path
/api/clientGET
List servers
Yes (Client)
/api/client
/api/client/servers/{identifier}GET
Get server details
Yes (Client)
/api/client/servers/1a7ce997
/api/client/servers/{identifier}/websocketGET
Generate websocket credentials
Yes (Client)
/api/client/servers/1a7ce997/websocket
/api/client/servers/{identifier}/resourcesGET
Get server resource usage
Yes (Client)
/api/client/servers/1a7ce997/resources
/api/client/servers/{identifier}/commandPOST
Send console command
Yes (Client)
/api/client/servers/1a7ce997/command
/api/client/servers/{identifier}/powerPOST
Send power signal
Yes (Client)
/api/client/servers/1a7ce997/power
/api/client/servers/{identifier}/settings/renamePOST
Rename server
Yes (Client)
/api/client/servers/1a7ce997/settings/rename
/api/client/servers/{identifier}/settings/reinstallPOST
Reinstall server
Yes (Client)
/api/client/servers/1a7ce997/settings/reinstall
/api/client/servers/{identifier}/startupGET
List startup variables
Yes (Client)
/api/client/servers/1a7ce997/startup
/api/client/servers/{identifier}/startup/variablePUT
Update startup variable
Yes (Client)
/api/client/servers/1a7ce997/startup/variable
/api/client/servers/{identifier}/activityGET
List server activity logs
Yes (Client)
/api/client/servers/1a7ce997/activity
Endpoint
Method
Description
Auth Required
Example Path
/api/client/servers/{identifier}/backupsGET
List backups
Yes (Client)
/api/client/servers/1a7ce997/backups
/api/client/servers/{identifier}/backupsPOST
Create backup
Yes (Client)
/api/client/servers/1a7ce997/backups
/api/client/servers/{identifier}/backups/{backup}GET
Get backup details
Yes (Client)
/api/client/servers/1a7ce997/backups/904df120-...
/api/client/servers/{identifier}/backups/{backup}/downloadGET
Generate backup download URL
Yes (Client)
/api/client/servers/1a7ce997/backups/904df120-.../download
/api/client/servers/{identifier}/backups/{backup}DELETE
Delete backup
Yes (Client)
/api/client/servers/1a7ce997/backups/904df120-...
Endpoint
Method
Description
Auth Required
Example Path
/api/client/servers/{identifier}/network/allocationsGET
List allocations
Yes (Client)
/api/client/servers/1a7ce997/network/allocations
/api/client/servers/{identifier}/network/allocationsPOST
Assign allocation
Yes (Client)
/api/client/servers/1a7ce997/network/allocations
/api/client/servers/{identifier}/network/allocations/{allocation}POST
Update allocation notes
Yes (Client)
/api/client/servers/1a7ce997/network/allocations/2
/api/client/servers/{identifier}/network/allocations/{allocation}/primaryPOST
Set primary allocation
Yes (Client)
/api/client/servers/1a7ce997/network/allocations/1/primary
/api/client/servers/{identifier}/network/allocations/{allocation}DELETE
Delete allocation
Yes (Client)
/api/client/servers/1a7ce997/network/allocations/2
Endpoint
Method
Description
Auth Required
Example Path
/api/client/servers/{identifier}/usersGET
List subusers
Yes (Client)
/api/client/servers/1a7ce997/users
/api/client/servers/{identifier}/usersPOST
Create subuser
Yes (Client)
/api/client/servers/1a7ce997/users
/api/client/servers/{identifier}/users/{subuser}GET
Get subuser details
Yes (Client)
/api/client/servers/1a7ce997/users/73f233ca-...
/api/client/servers/{identifier}/users/{subuser}POST
Update subuser permissions
Yes (Client)
/api/client/servers/1a7ce997/users/73f233ca-...
/api/client/servers/{identifier}/users/{subuser}DELETE
Delete subuser
Yes (Client)
/api/client/servers/1a7ce997/users/73f233ca-...
Endpoint
Method
Description
Auth Required
Example Path
/api/client/servers/{identifier}/schedulesGET
List schedules
Yes (Client)
/api/client/servers/1a7ce997/schedules
/api/client/servers/{identifier}/schedulesPOST
Create schedule
Yes (Client)
/api/client/servers/1a7ce997/schedules
/api/client/servers/{identifier}/schedules/{schedule}GET
Get schedule details
Yes (Client)
/api/client/servers/1a7ce997/schedules/1
/api/client/servers/{identifier}/schedules/{schedule}POST
Update schedule
Yes (Client)
/api/client/servers/1a7ce997/schedules/1
/api/client/servers/{identifier}/schedules/{schedule}DELETE
Delete schedule
Yes (Client)
/api/client/servers/1a7ce997/schedules/1
/api/client/servers/{identifier}/schedules/{schedule}/tasksPOST
Create schedule task
Yes (Client)
/api/client/servers/1a7ce997/schedules/1/tasks
/api/client/servers/{identifier}/schedules/{schedule}/tasks/{task}POST
Update schedule task
Yes (Client)
/api/client/servers/1a7ce997/schedules/1/tasks/2
/api/client/servers/{identifier}/schedules/{schedule}/tasks/{task}DELETE
Delete schedule task
Yes (Client)
/api/client/servers/1a7ce997/schedules/1/tasks/2
Endpoint
Method
Description
Auth Required
Example Path
/api/client/servers/{identifier}/files/listGET
List directory contents
Yes (Client)
/api/client/servers/1a7ce997/files/list?directory=%2Fcache
/api/client/servers/{identifier}/files/contentsGET
Get raw file contents
Yes (Client)
/api/client/servers/1a7ce997/files/contents?file=%2F.env
/api/client/servers/{identifier}/files/downloadGET
Generate file download URL
Yes (Client)
/api/client/servers/1a7ce997/files/download?file=%2F.env
/api/client/servers/{identifier}/files/renamePUT
Rename files or folders
Yes (Client)
/api/client/servers/1a7ce997/files/rename
/api/client/servers/{identifier}/files/copyPOST
Copy files
Yes (Client)
/api/client/servers/1a7ce997/files/copy
/api/client/servers/{identifier}/files/writePOST
Write file contents
Yes (Client)
/api/client/servers/1a7ce997/files/write?file=%2F.env
/api/client/servers/{identifier}/files/compressPOST
Compress files
Yes (Client)
/api/client/servers/1a7ce997/files/compress
/api/client/servers/{identifier}/files/decompressPOST
Decompress archive
Yes (Client)
/api/client/servers/1a7ce997/files/decompress
/api/client/servers/{identifier}/files/deletePOST
Delete files or folders
Yes (Client)
/api/client/servers/1a7ce997/files/delete
/api/client/servers/{identifier}/files/create-folderPOST
Create directory
Yes (Client)
/api/client/servers/1a7ce997/files/create-folder
/api/client/servers/{identifier}/files/uploadGET
Generate file upload URL
Yes (Client)
/api/client/servers/1a7ce997/files/upload
Endpoint
Method
Description
Auth Required
Example Path
/api/client/servers/{identifier}/databasesGET
List server databases
Yes (Client)
/api/client/servers/1a7ce997/databases
/api/client/servers/{identifier}/databasesPOST
Create database
Yes (Client)
/api/client/servers/1a7ce997/databases
/api/client/servers/{identifier}/databases/{database}/rotate-passwordPOST
Rotate database password
Yes (Client)
/api/client/servers/1a7ce997/databases/abc123/rotate-password
/api/client/servers/{identifier}/databases/{database}DELETE
Delete database
Yes (Client)
/api/client/servers/1a7ce997/databases/abc123
✅ Full Pterodactyl API Compatibility : Complete implementation of Pterodactyl's Application API
✅ Pagination Support : All list endpoints support pagination with page and per_page parameters
✅ Relationship Loading : Support for include parameter to load related resources
✅ Comprehensive CRUD Operations : Create, Read, Update, Delete for all resources
✅ Advanced Server Management : Suspend, unsuspend, reinstall, and detailed configuration updates
✅ Node & Allocation Management : Complete node lifecycle management with allocation handling
✅ Database Management : Full server database CRUD with password management
✅ Nest & Egg Management : Server type and configuration management
✅ Location Management : Geographic location organization
✅ User Management : Complete user lifecycle with external ID support
✅ API Key Management : Admin interface for API key creation and management
✅ Environment Variables : Proper handling of server environment variables
✅ Wings Integration : Node configuration generation for Wings daemon
✅ Error Handling : Comprehensive error responses following Pterodactyl standards
✅ Activity Logging : All operations are logged for audit purposes
✅ Email Notifications : Automated email notifications for server operations
All Application API endpoints require a valid API key to be provided in the Authorization header as a Bearer token:
Authorization: Bearer ptla_YOUR_API_KEY
Accept: Application/vnd.pterodactyl.v1+json Admin endpoints require admin authentication with appropriate permissions.