Eggs
List eggs
Retrieves a list of eggs
Available include parameters
| Parameter | Description |
|---|---|
| nest | Information about the nest that owns the egg |
| servers | List of servers using the egg |
| config | Config options of the egg |
| script | Egg install script |
| variables | List of egg variables |
GET
/api/application/nests/{nest}/eggsAuthorization
ApplicationToken AuthorizationBearer <token>
Application API key (generated at /admin/api)
In: header
Path Parameters
nest*integer
Nest ID
Query Parameters
include?string
Comma-separated list of related resources to embed in each returned object. Accepted values are listed in the include-parameters table above.
Response Body
application/json
curl -X GET "https://pterodactyl.file.properties/api/application/nests/1/eggs?include=nest%2Cservers" \ -H "Authorization: Bearer ptla_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \ -H "Accept: application/json"{
"object": "list",
"data": [
{
"object": "egg",
"attributes": {
"id": 1,
"uuid": "695648dd-01a3-4ced-b075-d4ec4fb9fbf4",
"name": "Bungeecord",
"nest": 1,
"author": "[email protected]",
"description": "For a long time, Minecraft server owners have had a dream that encompasses a free, easy, and reliable way to connect multiple Minecraft servers together. BungeeCord is the answer to said dream. Whether you are a small server wishing to string multiple game-modes together, or the owner of the ShotBow Network, BungeeCord is the ideal solution for you. With the help of BungeeCord, you will be able to unlock your community's full potential.",
"docker_image": "quay.io/pterodactyl/core:java",
"docker_images": {
"Default": "quay.io/pterodactyl/core:java"
},
"config": {
"files": {
"config.yml": {
"parser": "yaml",
"find": {
"listeners[0].query_enabled": true,
"listeners[0].query_port": "{{server.build.default.port}}",
"listeners[0].host": "0.0.0.0:{{server.build.default.port}}",
"servers.*.address": {
"127.0.0.1": "{{config.docker.interface}}",
"localhost": "{{config.docker.interface}}"
}
}
}
},
"startup": {
"done": "Listening on ",
"userInteraction": [
"Listening on /0.0.0.0:25577"
]
},
"stop": "end",
"logs": {
"custom": false,
"location": "proxy.log.0"
},
"file_denylist": [],
"extends": null
},
"startup": "java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}",
"script": {
"privileged": true,
"install": "#!/bin/ash\n# Bungeecord Installation Script\n#\n# Server Files: /mnt/server\napk update\napk add curl\n\ncd /mnt/server\n\nif [ -z \"${BUNGEE_VERSION}\" ] || [ \"${BUNGEE_VERSION}\" == \"latest\" ]; then\n BUNGEE_VERSION=\"lastStableBuild\"\nfi\n\ncurl -o ${SERVER_JARFILE} https://ci.md-5.net/job/BungeeCord/${BUNGEE_VERSION}/artifact/bootstrap/target/BungeeCord.jar",
"entry": "ash",
"container": "alpine:3.9",
"extends": null
},
"created_at": "2019-12-22T04:42:51+00:00",
"updated_at": "2019-12-22T04:42:51+00:00",
"relationships": {
"nest": {
"object": "nest",
"attributes": {
"id": 1,
"uuid": "58bde975-ec57-4af2-b241-1426ac6d6d59",
"author": "[email protected]",
"name": "Minecraft",
"description": "Minecraft - the classic game from Mojang. With support for Vanilla MC, Spigot, and many others!",
"created_at": "2019-12-22T04:42:51+00:00",
"updated_at": "2019-12-22T04:42:51+00:00"
}
},
"servers": {
"object": "list",
"data": []
}
}
}
},
{
"object": "egg",
"attributes": {
"id": 2,
"uuid": "7f8736d8-fd99-465f-8c3e-cb4d42c18541",
"name": "Forge Minecraft",
"nest": 1,
"author": "[email protected]",
"description": "Minecraft Forge Server. Minecraft Forge is a modding API (Application Programming Interface), which makes it easier to create mods, and also make sure mods are compatible with each other.",
"docker_image": "quay.io/pterodactyl/core:java",
"docker_images": {
"Default": "quay.io/pterodactyl/core:java"
},
"config": {
"files": {
"server.properties": {
"parser": "properties",
"find": {
"server-ip": "0.0.0.0",
"enable-query": "true",
"server-port": "{{server.build.default.port}}",
"query.port": "{{server.build.default.port}}"
}
}
},
"startup": {
"done": ")! For help, type ",
"userInteraction": [
"Go to eula.txt for more info."
]
},
"stop": "stop",
"logs": {
"custom": false,
"location": "logs/latest.log"
},
"file_denylist": [],
"extends": null
},
"startup": "java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}",
"script": {
"privileged": true,
"install": "#!/bin/bash\r\n# Forge Installation Script\r\n#\r\n# Server Files: /mnt/server\r\napt update\r\napt install -y curl\r\n\r\n#Fetching version\r\nif [ -z \"$MC_VERSION\" ] || [ \"$MC_VERSION\" == \"latest\" ]; then\r\n echo \"Fetching latest\"\r\n MC_VERSION=$(curl -sl https://files.minecraftforge.net/maven/net/minecraftforge/forge/index.html | grep -A 2 \"Latest\" | awk NF=NF RS= OFS=\" \" | grep -o -e '[1].[0-9]*.[0-9]* - [0-9]*.[0-9]*.[0-9]*.[0-9]*' | sed 's/ //g')\r\nelif [[ ! \"$MC_VERSION\" =~ - ]]; then\r\n echo \"Fetching latest from version $MC_VERSION\"\r\n MC_VERSION=$(curl -sl https://files.minecraftforge.net/maven/net/minecraftforge/forge/index_$MC_VERSION.html | grep -A 2 \"Latest\" | awk NF=NF RS= OFS=\" \" | grep -o -e '[1].[0-9]*.[0-9]* - [0-9]*.[0-9]*.[0-9]*.[0-9]*' | sed 's/ //g')\r\nfi\r\n\r\n#Checking if forge version valid\r\nif [[ ! \"$MC_VERSION\" =~ [1].[0-9]*.[0-9]*-[0-9]*.[0-9]*.[0-9]*.[0-9]* ]]; then\r\n echo \"!!! Invalid forge version \\\"$MC_VERSION\\\" !!!\"\r\n exit\r\nfi\r\n\r\n#Go into main direction\r\ncd /mnt/server\r\n\r\n#Adding .jar when not eding by SERVER_JARFILE\r\nif [[ ! $SERVER_JARFILE = *\\.jar ]]; then\r\n SERVER_JARFILE=\"$SERVER_JARFILE.jar\"\r\nfi\r\n\r\n#Downloading jars\r\necho -e \"Downloading forge version \\\"$MC_VERSION\\\"\"\r\ncurl -o installer.jar -sS https://files.minecraftforge.net/maven/net/minecraftforge/forge/$MC_VERSION/forge-$MC_VERSION-installer.jar\r\ncurl -o $SERVER_JARFILE -sS https://files.minecraftforge.net/maven/net/minecraftforge/forge/$MC_VERSION/forge-$MC_VERSION-universal.jar\r\n\r\n#Checking if downloaded jars exist\r\nif [ ! -f ./installer.jar ] || [ ! -f ./$SERVER_JARFILE ]; then\r\n echo \"!!! Error by downloading forge version \\\"$MC_VERSION\\\" !!!\"\r\n exit\r\nfi\r\n\r\n#Installing server\r\necho -e \"Installing forge server.\\n\"\r\njava -jar installer.jar --installServer\r\n\r\n#Deleting installer.jar\r\necho -e \"Deleting installer.jar file.\\n\"\r\nrm -rf installer.jar",
"entry": "bash",
"container": "openjdk:8",
"extends": null
},
"created_at": "2019-12-22T04:42:51+00:00",
"updated_at": "2019-12-22T04:42:51+00:00",
"relationships": {
"nest": {
"object": "nest",
"attributes": {
"id": 1,
"uuid": "58bde975-ec57-4af2-b241-1426ac6d6d59",
"author": "[email protected]",
"name": "Minecraft",
"description": "Minecraft - the classic game from Mojang. With support for Vanilla MC, Spigot, and many others!",
"created_at": "2019-12-22T04:42:51+00:00",
"updated_at": "2019-12-22T04:42:51+00:00"
}
},
"servers": {
"object": "list",
"data": []
}
}
}
},
{
"object": "egg",
"attributes": {
"id": 3,
"uuid": "2ad75dfd-892d-4441-a452-6d7be7cc895a",
"name": "Paper",
"nest": 1,
"author": "[email protected]",
"description": "High performance Spigot fork that aims to fix gameplay and mechanics inconsistencies.",
"docker_image": "quay.io/pterodactyl/core:java",
"docker_images": {
"Default": "quay.io/pterodactyl/core:java"
},
"config": {
"files": {
"server.properties": {
"parser": "properties",
"find": {
"server-ip": "0.0.0.0",
"server-port": "{{server.build.default.port}}"
}
}
},
"startup": {
"done": ")! For help, type ",
"userInteraction": [
"Go to eula.txt for more info."
]
},
"stop": "stop",
"logs": [],
"file_denylist": [],
"extends": null
},
"startup": "java -Xms128M -Xmx{{SERVER_MEMORY}}M -Dterminal.jline=false -Dterminal.ansi=true -jar {{SERVER_JARFILE}}",
"script": {
"privileged": true,
"install": "#!/bin/ash\r\n# Paper Installation Script\r\n#\r\n# Server Files: /mnt/server\r\napk add --no-cache --update curl jq\r\n\r\nif [ -n \"${DL_PATH}\" ]; then\r\n echo -e \"using supplied download url\"\r\n DOWNLOAD_URL=`eval echo $(echo ${DL_PATH} | sed -e 's/{{/${/g' -e 's/}}/}/g')`\r\nelse\r\n VER_EXISTS=`curl -s https://papermc.io/api/v1/paper | jq -r --arg VERSION $MINECRAFT_VERSION '.versions[] | IN($VERSION)' | grep true`\r\n LATEST_PAPER_VERSION=`curl -s https://papermc.io/api/v1/paper | jq -r '.versions' | jq -r '.[0]'`\r\n \r\n if [ \"${VER_EXISTS}\" == \"true\" ]; then\r\n echo -e \"Version is valid. Using version ${MINECRAFT_VERSION}\"\r\n else\r\n echo -e \"Using the latest paper version\"\r\n MINECRAFT_VERSION=${LATEST_PAPER_VERSION}\r\n fi\r\n \r\n BUILD_EXISTS=`curl -s https://papermc.io/api/v1/paper/${MINECRAFT_VERSION} | jq -r --arg BUILD ${BUILD_NUMBER} '.builds.all[] | IN($BUILD)' | grep true`\r\n LATEST_PAPER_BUILD=`curl -s https://papermc.io/api/v1/paper/${MINECRAFT_VERSION} | jq -r '.builds.latest'`\r\n \r\n if [ \"${BUILD_EXISTS}\" == \"true\" ] || [ ${BUILD_NUMBER} == \"latest\" ]; then\r\n echo -e \"Build is valid. Using version ${BUILD_NUMBER}\"\r\n else\r\n echo -e \"Using the latest paper build\"\r\n BUILD_NUMBER=${LATEST_PAPER_BUILD}\r\n fi\r\n \r\n echo \"Version being downloaded\"\r\n echo -e \"MC Version: ${MINECRAFT_VERSION}\"\r\n echo -e \"Build: ${BUILD_NUMBER}\"\r\n DOWNLOAD_URL=https://papermc.io/api/v1/paper/${MINECRAFT_VERSION}/${BUILD_NUMBER}/download \r\nfi\r\n\r\ncd /mnt/server\r\n\r\necho -e \"running curl -o ${SERVER_JARFILE} ${DOWNLOAD_URL}\"\r\n\r\nif [ -f ${SERVER_JARFILE} ]; then\r\n mv ${SERVER_JARFILE} ${SERVER_JARFILE}.old\r\nfi\r\n\r\ncurl -o ${SERVER_JARFILE} ${DOWNLOAD_URL}\r\n\r\nif [ ! -f server.properties ]; then\r\n echo -e \"Downloading MC server.properties\"\r\n curl -o server.properties https://raw.githubusercontent.com/parkervcp/eggs/master/minecraft_java/server.properties\r\nfi",
"entry": "ash",
"container": "alpine:3.9",
"extends": null
},
"created_at": "2019-12-22T04:42:51+00:00",
"updated_at": "2019-12-22T04:42:51+00:00",
"relationships": {
"nest": {
"object": "nest",
"attributes": {
"id": 1,
"uuid": "58bde975-ec57-4af2-b241-1426ac6d6d59",
"author": "[email protected]",
"name": "Minecraft",
"description": "Minecraft - the classic game from Mojang. With support for Vanilla MC, Spigot, and many others!",
"created_at": "2019-12-22T04:42:51+00:00",
"updated_at": "2019-12-22T04:42:51+00:00"
}
},
"servers": {
"object": "list",
"data": []
}
}
}
},
{
"object": "egg",
"attributes": {
"id": 4,
"uuid": "00274063-5d21-439f-80b9-c4cc0dba8188",
"name": "Sponge (SpongeVanilla)",
"nest": 1,
"author": "[email protected]",
"description": "SpongeVanilla is the SpongeAPI implementation for Vanilla Minecraft.",
"docker_image": "quay.io/pterodactyl/core:java-glibc",
"docker_images": {
"Default": "quay.io/pterodactyl/core:java-glibc"
},
"config": {
"files": {
"server.properties": {
"parser": "properties",
"find": {
"server-ip": "0.0.0.0",
"enable-query": "true",
"server-port": "{{server.build.default.port}}",
"query.port": "{{server.build.default.port}}"
}
}
},
"startup": {
"done": ")! For help, type ",
"userInteraction": [
"Go to eula.txt for more info."
]
},
"stop": "stop",
"logs": {
"custom": false,
"location": "logs/latest.log"
},
"file_denylist": [],
"extends": null
},
"startup": "java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}",
"script": {
"privileged": true,
"install": "#!/bin/ash\n# Sponge Installation Script\n#\n# Server Files: /mnt/server\n\napk update\napk add curl\n\ncd /mnt/server\n\ncurl -sSL \"https://repo.spongepowered.org/maven/org/spongepowered/spongevanilla/${SPONGE_VERSION}/spongevanilla-${SPONGE_VERSION}.jar\" -o ${SERVER_JARFILE}",
"entry": "ash",
"container": "alpine:3.9",
"extends": null
},
"created_at": "2019-12-22T04:42:51+00:00",
"updated_at": "2019-12-22T04:42:51+00:00",
"relationships": {
"nest": {
"object": "nest",
"attributes": {
"id": 1,
"uuid": "58bde975-ec57-4af2-b241-1426ac6d6d59",
"author": "[email protected]",
"name": "Minecraft",
"description": "Minecraft - the classic game from Mojang. With support for Vanilla MC, Spigot, and many others!",
"created_at": "2019-12-22T04:42:51+00:00",
"updated_at": "2019-12-22T04:42:51+00:00"
}
},
"servers": {
"object": "list",
"data": []
}
}
}
},
{
"object": "egg",
"attributes": {
"id": 5,
"uuid": "cd4cc5cf-de80-4a50-b458-dbd7d3193175",
"name": "Vanilla Minecraft",
"nest": 1,
"author": "[email protected]",
"description": "Minecraft is a game about placing blocks and going on adventures. Explore randomly generated worlds and build amazing things from the simplest of homes to the grandest of castles. Play in Creative Mode with unlimited resources or mine deep in Survival Mode, crafting weapons and armor to fend off dangerous mobs. Do all this alone or with friends.",
"docker_image": "quay.io/pterodactyl/core:java",
"docker_images": {
"Default": "quay.io/pterodactyl/core:java"
},
"config": {
"files": {
"server.properties": {
"parser": "properties",
"find": {
"server-ip": "0.0.0.0",
"enable-query": "true",
"server-port": "{{server.build.default.port}}",
"query.port": "{{server.build.default.port}}"
}
}
},
"startup": {
"done": ")! For help, type ",
"userInteraction": [
"Go to eula.txt for more info."
]
},
"stop": "stop",
"logs": {
"custom": false,
"location": "logs/latest.log"
},
"file_denylist": [],
"extends": null
},
"startup": "java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}",
"script": {
"privileged": true,
"install": "#!/bin/ash\r\n# Vanilla MC Installation Script\r\n#\r\n# Server Files: /mnt/server\r\napk update\r\napk add curl jq\r\n\r\ncd /mnt/server\r\n\r\nLATEST_VERSION=`curl https://launchermeta.mojang.com/mc/game/version_manifest.json | jq -r '.latest.release'`\r\n\r\nif [ -z \"$VANILLA_VERSION\" ] || [ \"$VANILLA_VERSION\" == \"latest\" ]; then\r\n MANIFEST_URL=$(curl https://launchermeta.mojang.com/mc/game/version_manifest.json | jq .versions | jq -r '.[] | select(.id == \"'$LATEST_VERSION'\") | .url')\r\nelse\r\n MANIFEST_URL=$(curl https://launchermeta.mojang.com/mc/game/version_manifest.json | jq .versions | jq -r '.[] | select(.id == \"'$VANILLA_VERSION'\") | .url')\r\nfi\r\n\r\nDOWNLOAD_URL=`curl $MANIFEST_URL | jq .downloads.server | jq -r '. | .url'`\r\n\r\ncurl -o ${SERVER_JARFILE} $DOWNLOAD_URL",
"entry": "ash",
"container": "alpine:3.9",
"extends": null
},
"created_at": "2019-12-22T04:42:51+00:00",
"updated_at": "2019-12-22T04:42:51+00:00",
"relationships": {
"nest": {
"object": "nest",
"attributes": {
"id": 1,
"uuid": "58bde975-ec57-4af2-b241-1426ac6d6d59",
"author": "[email protected]",
"name": "Minecraft",
"description": "Minecraft - the classic game from Mojang. With support for Vanilla MC, Spigot, and many others!",
"created_at": "2019-12-22T04:42:51+00:00",
"updated_at": "2019-12-22T04:42:51+00:00"
}
},
"servers": {
"object": "list",
"data": [
{
"object": "server",
"attributes": {
"id": 5,
"external_id": "RemoteId1",
"uuid": "1a7ce997-259b-452e-8b4e-cecc464142ca",
"identifier": "1a7ce997",
"name": "Wuhu Island",
"description": "Matt from Wii Sports",
"status": null,
"suspended": false,
"limits": {
"memory": 512,
"swap": 0,
"disk": 200,
"io": 500,
"cpu": 0,
"threads": null,
"oom_disabled": false
},
"feature_limits": {
"databases": 5,
"allocations": 5,
"backups": 2
},
"user": 1,
"node": 1,
"allocation": 1,
"nest": 1,
"egg": 5,
"container": {
"startup_command": "java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}",
"image": "quay.io/pterodactyl/core:java",
"installed": 1,
"environment": {
"SERVER_JARFILE": "server.jar",
"VANILLA_VERSION": "latest",
"STARTUP": "java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}",
"P_SERVER_LOCATION": "Test",
"P_SERVER_UUID": "1a7ce997-259b-452e-8b4e-cecc464142ca"
}
},
"updated_at": "2020-06-13T04:20:53+00:00",
"created_at": "2019-12-23T06:46:27+00:00"
}
}
]
}
}
}
}
]
}