Eggs

Deployable software templates, sourced live from your panels.

List all eggs

GET /v1/eggs returns every egg across every enabled instance. Each is namespaced by instance:

json
{
  "count": 124,
  "eggs": [
    {
      "instanceId": "0e8f...",
      "instanceName": "us-cluster",
      "eggId": 3,
      "name": "Paper",
      "description": "High-performance Minecraft server",
      "dockerImages": { "Java 21": "ghcr.io/pterodactyl/yolks:java_21" }
    }
  ]
}

Egg detail

GET /v1/eggs/:instanceId/:eggId includes the startup command, docker images and the full variable schema — what you can pass in environment at deploy time.

json
{
  "eggId": 3,
  "name": "Paper",
  "startup": "java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}",
  "dockerImages": { "Java 21": "..." },
  "variables": [
    { "name": "Minecraft Version", "env": "MINECRAFT_VERSION", "default": "latest", "editable": true, "rules": "required|string" }
  ]
}

Choosing a docker image

If an egg offers multiple images, pass dockerImage with the value (not the label) when deploying. Omit it to use the egg's first/default image.