# Docs - v1: Pterodactyl 1.x - [Pterodactyl 1.x](/v1): Installation, administration, and API documentation for Pterodactyl 1.x. - Project Information - [Introduction](/v1/project): Open-source game server management panel built with PHP, React, and Go - [About](/v1/project/about): Information about the Pterodactyl project team, sponsors, and licensing - [Terminology](/v1/project/terminology): Key terms and concepts used throughout Pterodactyl documentation - [Community Standards](/v1/project/community): Guidelines and expectations for participating in the Pterodactyl community - Panel - [Getting Started](/v1/panel/getting-started): Complete guide to installing Pterodactyl Panel with all dependencies and initial configuration. - [Webserver Configuration](/v1/panel/webserver-configuration): Configure your webserver to serve the Pterodactyl Panel - [Additional Configuration](/v1/panel/additional-configuration): Additional configuration options for Pterodactyl Panel - [Updating the Panel](/v1/panel/updating): Guide for updating Pterodactyl Panel within the 1.x series - [Troubleshooting](/v1/panel/troubleshooting): Common issues and solutions for Pterodactyl Panel - Wings - [Wings](/v1/wings): Server control plane documentation for Pterodactyl Wings - [Installing Wings](/v1/wings/installing): Guide for installing Wings 1.0 server control plane - [Additional Configuration](/v1/wings/configuration): Advanced configuration options for Wings - [Upgrading Wings](/v1/wings/upgrading): Guide for upgrading Wings to newer versions - [Migrating to Wings](/v1/wings/migrating): Guide for migrating from the old Node.JS daemon to Wings - Community Guides - Panel Installation - [Debian 11, 12 & 13](/v1/guides/panel-installation/debian): Install Pterodactyl Panel on Debian 11, 12, and 13 - [CentOS 7](/v1/guides/panel-installation/centos7): Install Pterodactyl Panel on CentOS 7 with all dependencies and SSL configuration - [Enterprise Linux 8 and Fedora Server 40](/v1/guides/panel-installation/centos8): Install Pterodactyl Panel on CentOS 8, Rocky Linux 8, AlmaLinux 8, and Fedora Server 40 - Wings Installation - [CentOS 7](/v1/guides/wings-installation/centos7): Install Pterodactyl Wings on CentOS 7 - [Enterprise Linux 8 and Fedora Server 40](/v1/guides/wings-installation/centos8): Install Pterodactyl Wings on CentOS 8, Rocky Linux 8, AlmaLinux 8, and Fedora Server 40 - Tutorials - [Creating SSL Certificates](/v1/guides/tutorials/ssl-certificates): Create and manage SSL certificates for Pterodactyl Panel and Wings - [Setting up MySQL](/v1/guides/tutorials/mysql-setup): Configure MySQL databases for Pterodactyl Panel and game servers - [Artisan CLI](/v1/guides/tutorials/artisan): Learn how to use Laravel's Artisan CLI for managing your Pterodactyl Panel - Configuration - [Creating a New Node](/v1/guides/configuration/add-node): Step-by-step guide to adding a new node to your Pterodactyl Panel - [Upgrading PHP](/v1/guides/configuration/php-upgrade): Upgrade PHP to the latest version for your Pterodactyl Panel - [Using Mounts](/v1/guides/configuration/mounts): Mount directories from the host file-system into server containers - Egg Creation - [Creating a Custom Egg](/v1/guides/egg-creation/creating-custom-egg): Learn how to create custom eggs for your Pterodactyl Panel - [Egg Docker Images](/v1/guides/egg-creation/egg-docker-images): Available Docker images and yolks for Pterodactyl eggs - [Configuration Files & Startup Detection](/v1/guides/egg-creation/egg-config-parser): Configure process management, startup detection, and config file parsing for Pterodactyl eggs - [Egg Variables](/v1/guides/egg-creation/egg-variables): Define and manage custom and default variables for Pterodactyl eggs - [Egg Install Script](/v1/guides/egg-creation/egg-install-script): Write install scripts that set up server files for Pterodactyl eggs - [Creating a Custom Docker Image](/v1/guides/egg-creation/creating-custom-image): Build custom Docker images for use with Pterodactyl eggs - Customization - [Building Panel Assets](/v1/guides/customization/panel): Learn how to build and customize Pterodactyl Panel assets - [Building Wings](/v1/guides/customization/wings): Compile and customize Pterodactyl Wings from source - Games - [Minecraft](/v1/guides/games/minecraft): Configure Minecraft server networks with BungeeCord, Waterfall, and other proxy servers - API Reference (1.x) - [API Overview](/v1/api): The Pterodactyl 1.x APIs and how to authenticate with them. - **Client API** - Client general - [List servers](/v1/api/client-general/get-list-servers) - [Show permissions](/v1/api/client-general/get-show-permissions) - Client account - [Delete API key](/v1/api/client-account/delete-delete-api-key) - [2FA details](/v1/api/client-account/get-2fa-details) - [Account activity](/v1/api/client-account/get-account-activity) - [Account details](/v1/api/client-account/get-account-details) - [List API keys](/v1/api/client-account/get-list-api-keys) - [List SSH keys](/v1/api/client-account/get-list-ssh-keys) - [Create API key](/v1/api/client-account/post-create-api-key) - [Create SSH key](/v1/api/client-account/post-create-ssh-key) - [Disable 2FA](/v1/api/client-account/post-disable-2fa) - [Enable 2FA](/v1/api/client-account/post-enable-2fa) - [Remove SSH key](/v1/api/client-account/post-remove-ssh-key) - [Update email](/v1/api/client-account/put-update-email) - [Update password](/v1/api/client-account/put-update-password) - Client server - [Console details](/v1/api/client-server/get-console-details) - [Resource usage](/v1/api/client-server/get-resource-usage) - [Server activity](/v1/api/client-server/get-server-activity) - [Server details](/v1/api/client-server/get-server-details) - [Change power state](/v1/api/client-server/post-change-power-state) - [Send command](/v1/api/client-server/post-send-command) - Client server databases - [Delete database](/v1/api/client-server-databases/delete-delete-database) - [List databases](/v1/api/client-server-databases/get-list-databases) - [Create database](/v1/api/client-server-databases/post-create-database) - [Rotate password](/v1/api/client-server-databases/post-rotate-password) - Client server file manager - [Download file](/v1/api/client-server-file-manager/get-download-file) - [Get file contents](/v1/api/client-server-file-manager/get-get-file-contents) - [List files](/v1/api/client-server-file-manager/get-list-files) - [Upload file](/v1/api/client-server-file-manager/get-upload-file) - [Change file permissions](/v1/api/client-server-file-manager/post-chmod-file) - [Compress file](/v1/api/client-server-file-manager/post-compress-file) - [Copy file](/v1/api/client-server-file-manager/post-copy-file) - [Create folder](/v1/api/client-server-file-manager/post-create-folder) - [Decompress file](/v1/api/client-server-file-manager/post-decompress-file) - [Delete file](/v1/api/client-server-file-manager/post-delete-file) - [Pull remote file](/v1/api/client-server-file-manager/post-pull-file) - [Write file](/v1/api/client-server-file-manager/post-write-file) - [Rename file](/v1/api/client-server-file-manager/put-rename-file) - Client server schedules - [Delete schedule](/v1/api/client-server-schedules/delete-delete-schedule) - [Delete task](/v1/api/client-server-schedules/delete-delete-task) - [List schedules](/v1/api/client-server-schedules/get-list-schedules) - [Schedule details](/v1/api/client-server-schedules/get-schedule-details) - [Create schedule](/v1/api/client-server-schedules/post-create-schedule) - [Create task](/v1/api/client-server-schedules/post-create-task) - [Execute schedule](/v1/api/client-server-schedules/post-execute-schedule) - [Update schedule](/v1/api/client-server-schedules/post-update-schedule) - [Update task](/v1/api/client-server-schedules/post-update-task) - Client server network - [Unassign allocation](/v1/api/client-server-network/delete-unassign-allocation) - [List allocations](/v1/api/client-server-network/get-list-allocations) - [Assign allocation](/v1/api/client-server-network/post-assign-allocation) - [Set allocation note](/v1/api/client-server-network/post-set-allocation-note) - [Set primary allocation](/v1/api/client-server-network/post-set-primary-allocation) - Client server users - [Delete user](/v1/api/client-server-users/delete-delete-user) - [List Users](/v1/api/client-server-users/get-list-users) - [User details](/v1/api/client-server-users/get-user-details) - [Create User](/v1/api/client-server-users/post-create-user) - [Update user](/v1/api/client-server-users/post-update-user) - Client server backups - [Delete backup](/v1/api/client-server-backups/delete-delete-backup) - [Backup details](/v1/api/client-server-backups/get-backup-details) - [Download backup](/v1/api/client-server-backups/get-download-backup) - [List backups](/v1/api/client-server-backups/get-list-backups) - [Create backup](/v1/api/client-server-backups/post-create-backup) - [Restore backup](/v1/api/client-server-backups/post-restore-backup) - [Toggle backup lock](/v1/api/client-server-backups/post-toggle-backup-lock) - Client server startup - [List Variables](/v1/api/client-server-startup/get-list-variables) - [Update Variable](/v1/api/client-server-startup/put-update-variable) - Client server settings - [Reinstall server](/v1/api/client-server-settings/post-reinstall-server) - [Rename server](/v1/api/client-server-settings/post-rename-server) - [Update Docker image](/v1/api/client-server-settings/put-update-docker-image) - **Application API** - Application users - [Delete user](/v1/api/application-users/delete-delete-user) - [List users](/v1/api/application-users/get-list-users) - [User details](/v1/api/application-users/get-user-details) - [User details by external ID](/v1/api/application-users/get-user-external-details) - [Update user](/v1/api/application-users/patch-update-user) - [Create user](/v1/api/application-users/post-create-user) - Application nodes - [Delete node](/v1/api/application-nodes/delete-delete-node) - [List deployable nodes](/v1/api/application-nodes/get-deployable-nodes) - [List nodes](/v1/api/application-nodes/get-list-nodes) - [Node configuration](/v1/api/application-nodes/get-node-configuration) - [Node details](/v1/api/application-nodes/get-node-details) - [Update node](/v1/api/application-nodes/patch-update-node) - [Create node](/v1/api/application-nodes/post-create-node) - Application nodes allocations - [Delete allocation](/v1/api/application-nodes-allocations/delete-delete-allocation) - [List allocations](/v1/api/application-nodes-allocations/get-list-allocations) - [Create allocations](/v1/api/application-nodes-allocations/post-create-allocations) - Application locations - [Delete location](/v1/api/application-locations/delete-delete-location) - [List locations](/v1/api/application-locations/get-list-locations) - [Location details](/v1/api/application-locations/get-location-details) - [Update location](/v1/api/application-locations/patch-update-location) - [Create location](/v1/api/application-locations/post-create-location) - Application servers - [Delete server](/v1/api/application-servers/delete-delete-server) - [Force delete server](/v1/api/application-servers/delete-force-delete-server) - [List servers](/v1/api/application-servers/get-list-servers) - [Server details](/v1/api/application-servers/get-server-details) - [Server details by external ID](/v1/api/application-servers/get-server-external-details) - [Update build](/v1/api/application-servers/patch-update-build) - [Update details](/v1/api/application-servers/patch-update-details) - [Update startup](/v1/api/application-servers/patch-update-startup) - [Create server](/v1/api/application-servers/post-create-server) - [Reinstall server](/v1/api/application-servers/post-reinstall-server) - [Suspend server](/v1/api/application-servers/post-suspend-server) - [Unsuspend server](/v1/api/application-servers/post-unsuspend-server) - Application servers database management - [Delete database](/v1/api/application-servers-database-management/delete-delete-database) - [Database details](/v1/api/application-servers-database-management/get-database-details) - [List databases](/v1/api/application-servers-database-management/get-list-databases) - [Create database](/v1/api/application-servers-database-management/post-create-database) - [Reset password](/v1/api/application-servers-database-management/post-reset-password) - Application nests - [List nests](/v1/api/application-nests/get-list-nests) - [Nest details](/v1/api/application-nests/get-nest-details) - Application nests eggs management - [Egg details](/v1/api/application-nests-eggs-management/get-egg-details) - [List eggs](/v1/api/application-nests-eggs-management/get-list-eggs) - v2: Pterodactyl 2.0 - [Pterodactyl 2.0](/v2): Documentation for Pterodactyl Panel 2.0. - Project Information - [Introduction](/v2/project): Pterodactyl is an open-source game server management panel built with PHP, React, and Go. - [About](/v2/project/about): Information about the Pterodactyl project team, sponsors, and licensing - [How Pterodactyl Works](/v2/project/how-it-works): The parts of Pterodactyl, the terms these pages use, and the ports between them. - [Community Standards](/v2/project/community): Guidelines and expectations for participating in the Pterodactyl community - [Using AI With Pterodactyl](/v2/project/using-ai): AI assistants are tools you choose to use. What that means for you, what support to expect, and how to give an assistant the docs. - Panel - [Requirements](/v2/panel/requirements): The software Pterodactyl 2.0 needs, and how it works with Wings. - [Getting Started](/v2/panel/getting-started): Install Pterodactyl Panel 2.0 on your own server. - [Docker Deployment](/v2/panel/docker): Run the Pterodactyl 2.0 Panel with Docker Compose. - [Webserver Configuration](/v2/panel/webserver-configuration): Configure NGINX, Apache, or Caddy to serve the Panel. - [Additional Configuration](/v2/panel/additional-configuration): Configure backups, reverse proxies, reCAPTCHA, two-factor authentication, and telemetry. - [Updating the Panel](/v2/panel/updating): Update Pterodactyl Panel to a newer 2.x release. - [Troubleshooting](/v2/panel/troubleshooting): Find and fix common problems with the Panel and Wings. - Wings - [Installing Wings](/v2/wings/installing): Install Wings, the service that runs your game servers, on a node. - [Configuration](/v2/wings/configuration): What each setting in Wings' config.yml does, and when to change it. - [Upgrading Wings](/v2/wings/upgrading): Upgrade Wings to a newer version. - Extensions - [Extensions](/v2/extensions): Install, configure, and manage extensions that add features to your Panel. - [Building Extensions](/v2/extensions/building): Create an extension with API endpoints, settings, pages, and additions to the Panel's interface. - [Backend](/v2/extensions/backend): Give an extension a service provider, routes, authorization, migrations, settings, and background work. - [Frontend](/v2/extensions/frontend): Add to the Panel's interface with slots, screens, detail tabs, table columns, and component replacements. - [Data and Styling](/v2/extensions/data-and-styling): Read Panel data, call your extension's API, style components, and translate text. - [Testing and Packaging](/v2/extensions/testing-and-packaging): Test an extension, build it, package it for release, and keep it secure. - [Extension Reference](/v2/extensions/reference): The manifest, commands, backend helpers, SDK, and slots available to extensions. - Upgrading From 1.x - [Changes From 1.x](/v2/upgrading/changes-from-v1): The changes in Pterodactyl 2.0 that affect existing 1.x installations. - [Upgrading From 1.x](/v2/upgrading/upgrading-from-v1): Upgrade a native 1.x Panel installation to Pterodactyl 2.0. - [Testing the Upgrade](/v2/upgrading/testing-the-upgrade): Try the 1.x to 2.0 upgrade on a copy of your Panel before you upgrade the real one. - Community Guides - Tutorials - [Creating SSL Certificates](/v2/guides/tutorials/ssl-certificates): Get free certificates from Let's Encrypt for the Panel and for Wings. - [Setting Up MySQL](/v2/guides/tutorials/mysql-setup): Create the Panel's database, and database hosts that give your servers their own databases. - [Artisan Commands](/v2/guides/tutorials/artisan): Manage users, nodes, servers, and the Panel itself from the command line. - Configuration - [Creating a Node](/v2/guides/configuration/add-node): Add a node to the Panel, give it allocations, and connect Wings to it. - [Upgrading PHP](/v2/guides/configuration/php-upgrade): Move the Panel to a newer version of PHP. - [Using Mounts](/v2/guides/configuration/mounts): Share a directory from a node with the servers on it. - Egg Creation - [Creating a Custom Egg](/v2/guides/egg-creation/creating-custom-egg): Import an egg, or create your own, and organize eggs with tags. - [Docker Images](/v2/guides/egg-creation/egg-docker-images): Choose the Docker images an egg's servers run in. - [Startup and Configuration](/v2/guides/egg-creation/egg-config-parser): Control how Wings starts, watches, stops, and configures a server. - [Egg Variables](/v2/guides/egg-creation/egg-variables): Let users and administrators change a server's settings without editing its startup command. - [Install Scripts](/v2/guides/egg-creation/egg-install-script): Write the script that downloads and sets up a server's files. - [Creating a Custom Image](/v2/guides/egg-creation/creating-custom-image): Build your own Docker image for an egg, when the official images do not fit. - Customization - [Themes](/v2/guides/customization/themes): Change the Panel's colors and shapes without rebuilding it. - [Building Panel Assets](/v2/guides/customization/panel): Rebuild the Panel's frontend after you change its source code. - [Building Wings](/v2/guides/customization/wings): Compile Wings from its source code. - Games - [Minecraft Proxy Networks](/v2/guides/games/minecraft): Run a BungeeCord, Waterfall, or Velocity network, with backend servers hidden from the internet. - API Reference (2.0) - [API Overview](/v2/api): The Pterodactyl 2.0 APIs and how to authenticate with them. - Admin API: Root administrator endpoints for managing panel configuration and resources. - [List languages](/v2/api/admin-api/adminListLanguages): Returns the languages available for panel locale selectors. - [List extensions](/v2/api/admin-api/adminListExtensions): Returns discovered extensions, invalid manifests, and their install state. - [Install extension](/v2/api/admin-api/adminInstallExtension): Installs an uploaded .pteroext or .zip extension package. - [Get extension settings](/v2/api/admin-api/adminGetExtensionSettings): Returns the auto-render form schema (with current public values) for an extension that registered a settings definition. - [Update extension settings](/v2/api/admin-api/adminUpdateExtensionSettings): Validates against the extension's declared rules and persists the submitted values. Omitted fields keep their stored values. - [Enable extension](/v2/api/admin-api/adminEnableExtension): Enables an installed extension, publishes assets, and runs migrations. - [Disable extension](/v2/api/admin-api/adminDisableExtension): Disables an installed extension without removing files or data. - [Remove extension](/v2/api/admin-api/adminRemoveExtension): Deletes extension files, published assets, and the install record. - [List users](/v2/api/admin-api/adminListUsers): Returns a paginated list of panel users, sorted with root administrators first by default. - [Create user](/v2/api/admin-api/adminCreateUser): Creates a panel user. Optional password and language fields may be supplied explicitly. - [Get user by external ID](/v2/api/admin-api/adminGetUserByExternalID): Returns a single panel user by external identifier. - [Get user](/v2/api/admin-api/adminGetUser): Returns a single panel user by internal numeric ID. - [Delete user](/v2/api/admin-api/adminDeleteUser): Deletes a panel user. The authenticated administrator cannot delete their own account. - [Disable user two-factor authentication](/v2/api/admin-api/adminDisableUserTwoFactorAuthentication): Clears the configured TOTP secret and disables two-factor authentication for a user. - [Update user](/v2/api/admin-api/adminUpdateUser): Updates an existing panel user. Supplying a password changes the user password. - [Get node system information](/v2/api/admin-api/adminGetNodeSystemInformation): Proxies Wings system information for a node. - [Create node deploy token](/v2/api/admin-api/adminCreateNodeDeployToken): Creates or reuses an application API key that can deploy the specified node. - [Get node utilization](/v2/api/admin-api/adminGetNodeUtilization): Returns aggregate resource utilization for a node. - [List server mounts](/v2/api/admin-api/adminListServerMounts): Returns mount definitions that are eligible for a server, including whether each mount is attached. - [Attach server mount](/v2/api/admin-api/adminAttachServerMount): Attaches an eligible mount definition to a server. - [Detach server mount](/v2/api/admin-api/adminDetachServerMount): Detaches a mount definition from a server. - [List servers](/v2/api/admin-api/adminListServers): Returns a paginated list of servers. - [Create server](/v2/api/admin-api/adminCreateServer): Creates a server using explicit allocations or automatic deployment constraints. - [Get server by external ID](/v2/api/admin-api/adminGetServerByExternalID): Returns a single server by external identifier. - [Get server](/v2/api/admin-api/adminGetServer): Returns a single server by admin identifier. - [Delete server](/v2/api/admin-api/adminDeleteServer): Deletes a server and returns an error if Wings or database host cleanup fails. - [Update server details](/v2/api/admin-api/adminUpdateServerDetails): Updates a server name, owner, description, and external identifier. - [Update server build](/v2/api/admin-api/adminUpdateServerBuild): Updates server limits, primary allocation, and feature limits. - [Update server startup](/v2/api/admin-api/adminUpdateServerStartup): Updates the egg, Docker image, startup command, environment, and install-script behavior. - [Update server suspension](/v2/api/admin-api/adminUpdateServerSuspension): Suspends or unsuspends a server. - [Reinstall server](/v2/api/admin-api/adminReinstallServer): Queues a server reinstall through Wings. - [Rebuild server](/v2/api/admin-api/adminRebuildServer): Synchronizes the server configuration to Wings. - [Get server transfer progress](/v2/api/admin-api/adminGetServerTransferProgress): Returns the active transfer for a server, or 204 when no transfer is in progress. - [Transfer server](/v2/api/admin-api/adminTransferServer): Starts a server transfer to another node using the specified target allocations. - [Toggle server install state](/v2/api/admin-api/adminToggleServerInstallState): Toggles a server between installed and installing states unless it is marked as failed. - [Force delete server](/v2/api/admin-api/adminForceDeleteServer): Deletes a server while bypassing recoverable Wings or database host cleanup failures. - [List server databases](/v2/api/admin-api/adminListServerDatabases): Returns all databases assigned to a server. - [Create server database](/v2/api/admin-api/adminCreateServerDatabase): Creates a database for a server and returns the generated password. - [Get server database](/v2/api/admin-api/adminGetServerDatabase): Returns a single database assigned to a server. - [Delete server database](/v2/api/admin-api/adminDeleteServerDatabase): Deletes a database assigned to a server. - [Rotate server database password](/v2/api/admin-api/adminRotateServerDatabasePassword): Rotates the password for a database assigned to a server. - [List server backups](/v2/api/admin-api/adminListServerBackups): Returns a paginated list of backups assigned to a server. - [Toggle server backup lock](/v2/api/admin-api/adminToggleServerBackupLock): Toggles whether a server backup is locked against deletion. - [List nodes](/v2/api/admin-api/adminListNodes): Returns a paginated list of Wings nodes. - [Create node](/v2/api/admin-api/adminCreateNode): Creates a Wings node. HTTPS nodes must use a valid FQDN rather than a raw IP address. - [Get node](/v2/api/admin-api/adminGetNode): Returns a single Wings node by ID. - [Delete node](/v2/api/admin-api/adminDeleteNode): Deletes a node when it has no active servers. - [Get node configuration](/v2/api/admin-api/adminGetNodeConfiguration): Returns the raw Wings configuration payload for a node, including daemon authentication tokens. - [Update node](/v2/api/admin-api/adminUpdateNode): Updates a Wings node and optionally rotates its daemon secret. - [Sync node game tags](/v2/api/admin-api/adminSyncNodeGameTags): Replaces the games a node accepts. A node with no game tags accepts any egg. - [Sync node deployment tags](/v2/api/admin-api/adminSyncNodeDeploymentTags): Replaces the reservations on a node. A deploy must declare exactly these tags to land here. - [List node allocations](/v2/api/admin-api/adminListNodeAllocations): Returns a paginated list of allocations for a node. - [Create node allocations](/v2/api/admin-api/adminCreateNodeAllocations): Creates one or more allocations on a node from IP addresses and ports or port ranges. - [Bulk delete node allocations](/v2/api/admin-api/adminBulkDeleteNodeAllocations): Deletes multiple unassigned allocations from a node by allocation ID. - [List node allocation IPs](/v2/api/admin-api/adminListNodeAllocationIPs): Returns distinct allocation IP addresses for a node. - [List available node allocations](/v2/api/admin-api/adminListAvailableNodeAllocations): Returns unassigned allocations for a node. - [Delete node allocation IP block](/v2/api/admin-api/adminDeleteNodeAllocationIPBlock): Deletes every unassigned allocation for an IP address on a node. - [Update node allocation](/v2/api/admin-api/adminUpdateNodeAllocation): Updates the alias for a single allocation on a node. - [Delete node allocation](/v2/api/admin-api/adminDeleteNodeAllocation): Deletes a single unassigned allocation from a node. - [List locations](/v2/api/admin-api/adminListLocations): Returns a paginated list of locations. - [Create location](/v2/api/admin-api/adminCreateLocation): Creates a location for grouping nodes and servers. - [Get location](/v2/api/admin-api/adminGetLocation): Returns a single location by ID. - [Delete location](/v2/api/admin-api/adminDeleteLocation): Deletes a location when no dependent resources prevent removal. - [List eligible location nodes](/v2/api/admin-api/adminListEligibleLocationNodes): Returns nodes assigned to a location that can be selected for location-scoped workflows. - [Update location](/v2/api/admin-api/adminUpdateLocation): Updates a location short identifier and description. - [List mounts](/v2/api/admin-api/adminListMounts): Returns a paginated list of mount definitions. - [Create mount](/v2/api/admin-api/adminCreateMount): Creates a mount definition and generates its UUID. - [Get mount](/v2/api/admin-api/adminGetMount): Returns a single mount definition by ID. - [Delete mount](/v2/api/admin-api/adminDeleteMount): Deletes a mount definition. - [Update mount](/v2/api/admin-api/adminUpdateMount): Updates an existing mount definition. - [Attach eggs to mount](/v2/api/admin-api/adminAttachEggsToMount): Attaches one or more eggs to a mount definition without removing existing egg attachments. - [Detach egg from mount](/v2/api/admin-api/adminDetachEggFromMount): Removes a single egg attachment from a mount definition. - [Attach nodes to mount](/v2/api/admin-api/adminAttachNodesToMount): Attaches one or more nodes to a mount definition without removing existing node attachments. - [Detach node from mount](/v2/api/admin-api/adminDetachNodeFromMount): Removes a single node attachment from a mount definition. - [List egg catalog](/v2/api/admin-api/adminListEggCatalog): Returns the cached Pterodactyl egg catalog for searching and filtering. The index is cached for one hour. - [Refresh egg catalog](/v2/api/admin-api/adminRefreshEggCatalog): Clears the cached Pterodactyl catalog so the next listing downloads the current index. - [Import catalog egg](/v2/api/admin-api/adminImportCatalogEgg): Downloads the selected entry from the Pterodactyl catalog and imports its egg definition and variables. - [List egg variables](/v2/api/admin-api/adminListEggVariables): Returns variables for an egg in display order. - [Create egg variable](/v2/api/admin-api/adminCreateEggVariable): Creates a startup variable for an egg. - [Reorder egg variables](/v2/api/admin-api/adminReorderEggVariables): Updates the display order for variables on an egg. - [Update egg variable](/v2/api/admin-api/adminUpdateEggVariable): Updates a startup variable for an egg. - [Delete egg variable](/v2/api/admin-api/adminDeleteEggVariable): Deletes a startup variable from an egg. - [Get egg install script](/v2/api/admin-api/adminGetEggInstallScript): Returns an egg with its install script block. - [Update egg install script](/v2/api/admin-api/adminUpdateEggInstallScript): Updates the install script configuration for an egg. - [Export egg](/v2/api/admin-api/adminExportEgg): Downloads an egg share JSON file. - [Update egg from import](/v2/api/admin-api/adminUpdateEggFromImport): Updates an existing egg from an uploaded egg share JSON file. - [Sync egg tags](/v2/api/admin-api/adminSyncEggTags): Replaces the tags applied to an egg. Values may be tag IDs or new tag names. - [Import egg](/v2/api/admin-api/adminImportEgg): Creates an egg from an uploaded egg share JSON file. - [List eggs](/v2/api/admin-api/adminListEggs): Returns a paginated list of egg definitions. - [Create egg](/v2/api/admin-api/adminCreateEgg): Creates an egg definition. - [Get egg](/v2/api/admin-api/adminGetEgg): Returns a single egg definition by ID. - [Delete egg](/v2/api/admin-api/adminDeleteEgg): Deletes an egg definition. - [Update egg](/v2/api/admin-api/adminUpdateEgg): Updates an egg definition. - [List tags](/v2/api/admin-api/adminListTags): Returns a paginated list of tags. - [Create tag](/v2/api/admin-api/adminCreateTag): Creates a tag. - [Get tag](/v2/api/admin-api/adminGetTag): Returns a single tag by ID. - [Delete tag](/v2/api/admin-api/adminDeleteTag): Deletes a tag and detaches it from every egg and node. - [Update tag](/v2/api/admin-api/adminUpdateTag): Updates an existing tag. Built-in game tags cannot be edited. - [Get settings](/v2/api/admin-api/adminGetSettings): Returns current general, mail, advanced, and metadata settings. - [Update general settings](/v2/api/admin-api/adminUpdateGeneralSettings): Updates panel branding, 2FA requirements, and default locale settings. - [Update mail settings](/v2/api/admin-api/adminUpdateMailSettings): Updates SMTP mail settings and restarts queued workers so they reload configuration. - [Send test mail](/v2/api/admin-api/adminSendTestMail): Sends a test email to the authenticated administrator using the configured mail transport. - [Update advanced settings](/v2/api/admin-api/adminUpdateAdvancedSettings): Updates reCAPTCHA, HTTP client timeout, and client allocation feature settings. - [List database hosts](/v2/api/admin-api/adminListDatabaseHosts): Returns a paginated list of database hosts. - [Create database host](/v2/api/admin-api/adminCreateDatabaseHost): Creates a database host after validating that the panel can connect to it. - [Get database host](/v2/api/admin-api/adminGetDatabaseHost): Returns a single database host by ID. - [Delete database host](/v2/api/admin-api/adminDeleteDatabaseHost): Deletes a database host when no server databases depend on it. - [Update database host](/v2/api/admin-api/adminUpdateDatabaseHost): Updates a database host after validating that the panel can connect to the supplied host details. - [List database host databases](/v2/api/admin-api/adminListDatabaseHostDatabases): Returns a paginated list of server databases assigned to a database host. - [List API keys](/v2/api/admin-api/adminListAPIKeys): Returns a paginated list of application API keys. - [Create API key](/v2/api/admin-api/adminCreateAPIKey): Creates a new application API key and returns the plaintext secret token once. - [Get API key](/v2/api/admin-api/adminGetAPIKey): Returns a single application API key by identifier without exposing its token. - [Delete API key](/v2/api/admin-api/adminDeleteAPIKey): Deletes an application API key by identifier. - [Update API key](/v2/api/admin-api/adminUpdateAPIKey): Updates an application API key memo and resource permissions without regenerating the token. - [Get version information](/v2/api/admin-api/adminGetVersionInformation): Returns panel, Wings, and project version metadata. - Application API: Root administrator endpoints for managing panel resources using application API tokens. - [List users](/v2/api/application-api/applicationListUsers): Returns a paginated list of panel users visible to the application API key. - [Create user](/v2/api/application-api/applicationCreateUser): Creates a new panel user and returns the created resource. - [Get user](/v2/api/application-api/applicationGetUser): Returns a single panel user by internal numeric ID. - [Update user](/v2/api/application-api/applicationUpdateUser): Updates account details for an existing panel user. - [Delete user](/v2/api/application-api/applicationDeleteUser): Deletes a panel user by internal numeric ID. - [Get user by external ID](/v2/api/application-api/applicationGetUserByExternalID): Returns a single panel user by its external identifier. - [List nodes](/v2/api/application-api/applicationListNodes): Returns a paginated list of Wings nodes registered on the panel. - [Create node](/v2/api/application-api/applicationCreateNode): Creates a new Wings node and returns the created resource. - [List deployable nodes](/v2/api/application-api/applicationListDeployableNodes): Returns nodes that can satisfy the requested memory, disk, and optional location deployment constraints. - [Get node](/v2/api/application-api/applicationGetNode): Returns a single Wings node by internal numeric ID. - [Delete node](/v2/api/application-api/applicationDeleteNode): Deletes a Wings node by internal numeric ID when no servers are attached. - [Get node configuration](/v2/api/application-api/applicationGetNodeConfiguration): Returns the Wings configuration payload for a node, including node authentication tokens. - [Update node](/v2/api/application-api/applicationUpdateNode): Updates an existing Wings node by internal numeric ID. - [List node allocations](/v2/api/application-api/applicationListNodeAllocations): Returns a paginated list of allocations belonging to a node. - [Create node allocations](/v2/api/application-api/applicationCreateNodeAllocations): Assigns one or more allocation ports to a node. - [Delete node allocation](/v2/api/application-api/applicationDeleteNodeAllocation): Deletes an allocation from a node when no server is using it. - [List locations](/v2/api/application-api/applicationListLocations): Returns a paginated list of all locations registered on the panel. - [Create location](/v2/api/application-api/applicationCreateLocation): Creates a new location and returns the created resource. - [Get location](/v2/api/application-api/applicationGetLocation): Returns a single location by internal numeric ID. - [Update location](/v2/api/application-api/applicationUpdateLocation): Updates an existing location by internal numeric ID. - [Delete location](/v2/api/application-api/applicationDeleteLocation): Deletes a location by internal numeric ID. - [List eggs](/v2/api/application-api/applicationListEggs): Returns a paginated list of server eggs available on the panel. - [Get egg](/v2/api/application-api/applicationGetEgg): Returns a single egg by internal numeric ID. - [List tags](/v2/api/application-api/applicationListTags): Returns a paginated list of the tags that group eggs. - [Get tag](/v2/api/application-api/applicationGetTag): Returns a single tag by internal numeric ID. - [List servers](/v2/api/application-api/applicationListServers): Returns a paginated list of servers visible to the application API key. - [Create server](/v2/api/application-api/applicationCreateServer): Creates a new server using either explicit allocations or automatic deployment constraints. - [Get server](/v2/api/application-api/applicationGetServer): Returns a single server by internal numeric ID. - [Delete server](/v2/api/application-api/applicationDeleteServerForServersServerId): Deletes a server. The force route bypasses recoverable Wings or database host deletion failures. - [Get server by external ID](/v2/api/application-api/applicationGetServerByExternalID): Returns a single server by its external identifier. - [Update server details](/v2/api/application-api/applicationUpdateServerDetails): Updates ownership and display details for a server. - [Update server build](/v2/api/application-api/applicationUpdateServerBuild): Updates resource limits, feature limits, and allocations for a server. - [Update server startup](/v2/api/application-api/applicationUpdateServerStartup): Updates startup command, image, egg, and environment variables for a server. - [Suspend server](/v2/api/application-api/applicationSuspendServer): Marks a server as suspended and syncs the state to Wings. - [Unsuspend server](/v2/api/application-api/applicationUnsuspendServer): Clears a server suspension and syncs the state to Wings. - [Reinstall server](/v2/api/application-api/applicationReinstallServer): Marks a server for reinstall and asks Wings to reinstall it. - [Delete server](/v2/api/application-api/applicationDeleteServerForServersServerIdForce): Deletes a server. The force route bypasses recoverable Wings or database host deletion failures. - [List server databases](/v2/api/application-api/applicationListServerDatabases): Returns all databases attached to a server. - [Create server database](/v2/api/application-api/applicationCreateServerDatabase): Creates a database for a server on a configured database host. - [Get server database](/v2/api/application-api/applicationGetServerDatabase): Returns a single database attached to a server. - [Delete server database](/v2/api/application-api/applicationDeleteServerDatabase): Deletes a database attached to a server. - [Reset server database password](/v2/api/application-api/applicationResetServerDatabasePassword): Rotates the password for a database attached to a server. - Authentication: Browser session authentication endpoints used by the panel frontend. - [Login](/v2/api/authentication/authLogin): Authenticates a browser session. Returns a complete login payload, or a two-factor checkpoint token when the account requires a second factor. - [Complete login checkpoint](/v2/api/authentication/authCompleteLoginCheckpoint): Completes a two-factor login checkpoint using either a TOTP code or a recovery token. - [Request password reset email](/v2/api/authentication/authRequestPasswordResetEmail): Sends a password reset email when the account exists. The response is intentionally the same when no matching account is found. - [Reset password](/v2/api/authentication/authResetPassword): Resets an account password using a password reset token. The response tells the frontend whether the user must return to the login form. - [Logout](/v2/api/authentication/authLogout): Destroys the current browser session and regenerates the CSRF token. - [Get CSRF cookie](/v2/api/authentication/authGetCsrfCookie): Initializes the Laravel Sanctum CSRF cookie required before browser-session authentication requests. - Client API: Endpoints authenticated as a panel user using a client API token. - [List client servers](/v2/api/client-api/clientListClientServers): Returns a paginated list of servers the authenticated user can access as an owner, subuser, or administrator. - [List server permissions](/v2/api/client-api/clientListServerPermissions): Returns the permission keys that can be granted to server subusers. - [Get account](/v2/api/client-api/clientGetAccount): Returns profile details for the authenticated user. - [Get two-factor setup](/v2/api/client-api/clientGetTwoFactorSetup): Creates or returns the current two-factor setup payload for the authenticated user. - [Enable two-factor authentication](/v2/api/client-api/clientEnableTwoFactorAuthentication): Enables two-factor authentication for the authenticated user and returns one-time recovery tokens. - [Disable two-factor authentication](/v2/api/client-api/clientDisableTwoFactorAuthentication): Disables two-factor authentication for the authenticated user after verifying their password. - [Update account email](/v2/api/client-api/clientUpdateAccountEmail): Updates the authenticated user's email address after verifying their current password. - [Update account password](/v2/api/client-api/clientUpdateAccountPassword): Updates the authenticated user's password and revokes other active sessions where supported. - [List account activity](/v2/api/client-api/clientListAccountActivity): Returns a paginated list of activity log entries for the authenticated user account. - [List account API keys](/v2/api/client-api/clientListAccountAPIKeys): Returns all client API keys owned by the authenticated user. - [Create account API key](/v2/api/client-api/clientCreateAccountAPIKey): Creates a client API key for the authenticated user and returns the secret token once. - [Delete account API key](/v2/api/client-api/clientDeleteAccountAPIKey): Deletes one client API key owned by the authenticated user. - [List SSH keys](/v2/api/client-api/clientListSSHKeys): Returns all SSH public keys configured for the authenticated user. - [Create SSH key](/v2/api/client-api/clientCreateSSHKey): Adds an SSH public key to the authenticated user account. - [Delete SSH key](/v2/api/client-api/clientDeleteSSHKey): Deletes an SSH key from the authenticated user account by fingerprint. Missing keys are treated as already deleted. - [Get server](/v2/api/client-api/clientGetServer): Returns details for one server the authenticated user can access. - [Get websocket credentials](/v2/api/client-api/clientGetWebsocketCredentials): Returns a short-lived Wings websocket token and socket URL for the server. - [Get server resources](/v2/api/client-api/clientGetServerResources): Returns the latest cached resource utilization reported by Wings for the server. - [List server activity](/v2/api/client-api/clientListServerActivity): Returns a paginated list of activity log entries for the server. - [Send server command](/v2/api/client-api/clientSendServerCommand): Sends a console command to the running server through Wings. - [Send power action](/v2/api/client-api/clientSendPowerAction): Sends a power signal to the server through Wings. - [List server databases](/v2/api/client-api/clientListServerDatabases): Returns databases attached to a server visible to the authenticated user. - [Create server database](/v2/api/client-api/clientCreateServerDatabase): Creates a database for a server on an automatically selected database host. - [Rotate server database password](/v2/api/client-api/clientRotateServerDatabasePassword): Rotates the password for a database attached to a server and returns the updated database. - [Delete server database](/v2/api/client-api/clientDeleteServerDatabase): Deletes a database attached to a server. - [List files](/v2/api/client-api/clientListFiles): Returns files and folders in a server directory. - [Get file contents](/v2/api/client-api/clientGetFileContents): Returns raw text contents for a server file. - [Get file download URL](/v2/api/client-api/clientGetFileDownloadURL): Returns a short-lived signed URL for downloading a server file directly from Wings. - [Rename files](/v2/api/client-api/clientRenameFiles): Renames one or more files or folders in a server directory. - [Copy file](/v2/api/client-api/clientCopyFile): Creates a copy of a file on the server. - [Write file contents](/v2/api/client-api/clientWriteFileContents): Writes the raw request body to a server file. This endpoint does not expect a JSON wrapper for the file contents. - [Compress files](/v2/api/client-api/clientCompressFiles): Creates an archive from one or more files or folders in a server directory. - [Decompress file](/v2/api/client-api/clientDecompressFile): Extracts an archive in a server directory. - [Delete files](/v2/api/client-api/clientDeleteFiles): Deletes one or more files or folders from a server directory. - [Create folder](/v2/api/client-api/clientCreateFolder): Creates a folder in a server directory. - [Change file permissions](/v2/api/client-api/clientChangeFilePermissions): Updates POSIX mode bits for one or more files or folders in a server directory. - [Pull remote file](/v2/api/client-api/clientPullRemoteFile): Requests that Wings download a remote file into a server directory. - [Get file upload URL](/v2/api/client-api/clientGetFileUploadURL): Returns a short-lived signed URL for uploading a file directly to Wings. - [List server schedules](/v2/api/client-api/clientListServerSchedules): Returns all schedules configured for the server, including their tasks. - [Create server schedule](/v2/api/client-api/clientCreateServerSchedule): Creates a schedule for the server. - [Get server schedule](/v2/api/client-api/clientGetServerSchedule): Returns one schedule configured for the server, including its tasks. - [Update server schedule](/v2/api/client-api/clientUpdateServerSchedule): Updates a schedule for the server and recalculates its next run time. - [Delete server schedule](/v2/api/client-api/clientDeleteServerSchedule): Deletes a schedule and its tasks from the server. - [Execute server schedule](/v2/api/client-api/clientExecuteServerSchedule): Queues a schedule to run immediately regardless of its active state. - [Create schedule task](/v2/api/client-api/clientCreateScheduleTask): Creates a task in a server schedule. - [Update schedule task](/v2/api/client-api/clientUpdateScheduleTask): Updates a task in a server schedule, including its sequence position. - [Delete schedule task](/v2/api/client-api/clientDeleteScheduleTask): Deletes a task from a server schedule and compacts subsequent sequence IDs. - [List server allocations](/v2/api/client-api/clientListServerAllocations): Returns all network allocations assigned to the server. - [Create server allocation](/v2/api/client-api/clientCreateServerAllocation): Assigns an available allocation to the server. - [Update allocation notes](/v2/api/client-api/clientUpdateAllocationNotes): Updates notes attached to a server allocation. - [Delete server allocation](/v2/api/client-api/clientDeleteServerAllocation): Removes a non-primary allocation from the server and returns it to the available pool. - [Set primary allocation](/v2/api/client-api/clientSetPrimaryAllocation): Sets the primary network allocation for the server. - [List server subusers](/v2/api/client-api/clientListServerSubusers): Returns subusers assigned to the server. - [Create server subuser](/v2/api/client-api/clientCreateServerSubuser): Assigns an existing or new user as a subuser on the server. - [Get server subuser](/v2/api/client-api/clientGetServerSubuser): Returns one subuser assignment for the server. - [Update server subuser](/v2/api/client-api/clientUpdateServerSubuser): Updates permissions for a server subuser and revokes their SFTP access tokens. - [Delete server subuser](/v2/api/client-api/clientDeleteServerSubuser): Removes a subuser assignment from the server and revokes SFTP access tokens. - [List server backups](/v2/api/client-api/clientListServerBackups): Returns a paginated list of backups for the server. - [Create server backup](/v2/api/client-api/clientCreateServerBackup): Starts a new backup for the server. - [Get server backup](/v2/api/client-api/clientGetServerBackup): Returns information about one server backup. - [Delete server backup](/v2/api/client-api/clientDeleteServerBackup): Deletes a backup record and its stored archive. - [Get backup download URL](/v2/api/client-api/clientGetBackupDownloadURL): Returns a signed URL for downloading a server backup. - [Toggle backup lock](/v2/api/client-api/clientToggleBackupLock): Toggles whether a backup is locked against deletion. - [Restore server backup](/v2/api/client-api/clientRestoreServerBackup): Restores a backup over the server files. - [Get startup configuration](/v2/api/client-api/clientGetStartupConfiguration): Returns the rendered startup command, available Docker images, raw startup command, and user-visible variables for the server. - [Update startup variable](/v2/api/client-api/clientUpdateStartupVariable): Updates one editable startup variable for the server and returns the updated rendered startup command. - [Rename server](/v2/api/client-api/clientRenameServer): Updates the server name and optionally its description. - [Reinstall server](/v2/api/client-api/clientReinstallServer): Queues a reinstall of the server on Wings. - [Set server Docker image](/v2/api/client-api/clientSetServerDockerImage): Updates the server Docker image to one of the images allowed by the server egg.