Pterodactyl ApplicationInstall

Summary

Create a new server on the Pterodactyl panel with specified configuration such as name, owner, nest, egg, resource limits, and startup options.

Inputs

• Server Name (required) — Display name for the server.
• Description — Optional description for the server.
• Owner User (required) — User who will own the server.
• External ID — External identifier for integration with other systems.
• Nest (required) — Nest containing the egg for the server type.
• Egg (required) — Egg defining server type and default configuration.
• Docker Image (required) — Docker image to use for this server, loaded from the selected egg.
• Override Startup Command — Optionally override the egg's default startup command (leave empty to use default). Variables like {{SERVER_MEMORY}} can be used without expression mode.
• Memory Limit (MB) (required) — Maximum memory in megabytes the server can use.
• Swap Limit (MB) (required) — Maximum swap memory in megabytes to allow.
• Disk Limit (MB) (required) — Maximum disk space in megabytes.
• CPU Limit (%) (required) — CPU limit as a percentage (e.g., 100 = 1 core).
• IO Weight (required) — Block IO weight (10-1000) where higher is higher priority.
• Database Limit (required) — Maximum number of databases the server can create.
• Allocation Limit (required) — Maximum number of network allocations.
• Backup Limit (required) — Maximum number of backups the server can create.
• Node (required) — The node where the server will be hosted.
• Default Allocation (required) — Primary IP:Port allocation for the server; only unassigned allocations are shown.
• Environment Variables — Key-value pairs overriding the egg's default environment variables.
• Environment Variables (JSON) — JSON object of environment variables that override both egg defaults and UI key-values; supports dynamic injection from previous nodes.
• Start After Installation — Whether to automatically start the server after installation completes.
• Skip Install Scripts — Whether to skip running the egg installation scripts.
• Disable OOM Killer — Whether to disable the out-of-memory killer for this server.

Output shape

A single JSON object representing the newly created server's details as returned by the Pterodactyl Application API.

The output includes all server attributes and configuration set by the creation request. Errors during creation will throw unless 'Continue On Fail' is enabled, in which case error messages are returned per item.

Examples

Example 1: Create a new game server with customized startup command and resource limits.

Specify server name, assign owner user, select nest and egg, choose docker image, set memory, CPU, disk, and other limits, define environment variables, and optionally override startup command and control automatic start and install scripts.