Eggs

Plantillas de software desplegables, obtenidas en tiempo real desde tus paneles.

Listar todos los eggs

GET /v1/eggs devuelve todos los eggs de todas las instancias habilitadas. Cada uno tiene espacio de nombres por instancia:

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

Detalle de un egg

GET /v1/eggs/:instanceId/:eggId incluye el comando de arranque, las imágenes docker y el esquema completo de variables — lo que puedes pasar en environment al desplegar.

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" }
  ]
}

Elegir una imagen docker

Si un egg ofrece varias imágenes, pasa dockerImage con el valor (no la etiqueta) al desplegar. Omítelo para usar la primera imagen por defecto del egg.