Egg details

Retrieves the specified egg

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}/eggs/{egg}

Authorization

ApplicationToken

AuthorizationBearer <token>

Application API key (generated at /admin/api)

In: header

Path Parameters

nest*integer

Nest ID

egg*integer

Egg 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/1?include=nest%2Cservers" \  -H "Authorization: Bearer ptla_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \  -H "Accept: application/json"

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