import_egg
Destructive
Create or import server templates (eggs) in Pterodactyl to define Docker images, startup commands, and configurations for game servers.
Instructions
Import or create a new egg (server template) in a nest (admin action). Eggs define the Docker image, startup command, and configuration for a type of game server. Use list_nests to find the nest_id first. The egg will be available for creating new servers via create_server. Requires Application API key.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| nest_id | Yes | Nest ID to create the egg in (from list_nests) | |
| name | Yes | Display name for the egg | |
| description | No | Description of what this egg runs | |
| docker_image | Yes | Docker image to use (e.g. 'ghcr.io/image:tag') | |
| startup | Yes | Startup command with variable placeholders (e.g. 'java -jar {{SERVER_JARFILE}}') | |
| config_from | No | Egg ID to inherit configuration from | |
| config_stop | No | Stop command sent to the server process | |
| config_logs | No | JSON config for log parsing | |
| config_files | No | JSON config for file parser modifications | |
| config_startup | No | JSON config for startup detection | |
| script_container | No | Docker image for the install script (e.g. 'alpine:3.4') | |
| script_entry | No | Entrypoint for the install script (e.g. 'bash') | |
| script_install | No | Shell script executed during server installation |