Admin API: nest and egg configuration management

Nests are logical groupings of eggs. An egg defines how a game server is installed, configured, and started. The admin API provides endpoints to manage both nests under /api/admin/nests and egg configurations under /api/admin/egg-configurations.

Nests

List nests

Returns a paginated list of all nests.

GET /api/admin/nests

page

integer

default:"1"

Page number.

per_page

integer

default:"10"

Items per page (1–100).

string

Filter by nest name.

Required admin permission: nests.read

curl
Response

curl https://your-panel.example.com/api/admin/nests \
  -H "Authorization: Bearer ptlc_YourAdminKey"

{
  "nests": {
    "data": [
      {
        "uuid": "abc12345-...",
        "author": "support@example.com",
        "name": "Minecraft",
        "description": "Minecraft Java Edition eggs",
        "created": "2026-01-01T00:00:00Z"
      }
    ],
    "total": 1,
    "per_page": 10,
    "page": 1
  }
}

Get a nest

GET /api/admin/nests/{nest}

nest

string (UUID)

required

Nest UUID.

Required admin permission: nests.read

Create a nest

POST /api/admin/nests

author

string

required

Author identifier (typically an email address).

name

string

required

Nest name. Must be unique.

description

string

Optional description.

Required admin permission: nests.create

Update a nest

PATCH /api/admin/nests/{nest}

nest

string (UUID)

required

Nest UUID.

author

string

Updated author.

name

string

Updated name.

description

string

Updated description.

Required admin permission: nests.update

Delete a nest

DELETE /api/admin/nests/{nest}

nest

string (UUID)

required

Nest UUID.

Required admin permission: nests.delete

Deletion fails with 409 Conflict if the nest contains any eggs. Delete all eggs first.

Eggs

Eggs belong to a nest and define the installation script, startup command, configuration files, and available Docker images for a server type.

List eggs in a nest

GET /api/admin/nests/{nest}/eggs

nest

string (UUID)

required

Nest UUID.

page

integer

default:"1"

Page number.

per_page

integer

default:"10"

Items per page.

string

Filter by egg name.

Required admin permission: eggs.read

Get an egg

GET /api/admin/nests/{nest}/eggs/{egg}

nest

string (UUID)

required

Nest UUID.

egg

string (UUID)

required

Egg UUID.

Required admin permission: eggs.read

Create an egg

POST /api/admin/nests/{nest}/eggs

nest

string (UUID)

required

Nest UUID to add the egg to.

name

string

required

Egg name. 3–255 characters.

author

string

required

Author identifier. 2–255 characters.

description

string

Optional description. Maximum 1024 characters.

startup_commands

object

required

Map of startup command labels to command strings. At least one entry required. No duplicate commands.

docker_images

object

required

Map of image display names to Docker image references. No duplicate images.

config_files

array

Server configuration files to create or modify at startup.

Show config file object

file

string

required

Path to the configuration file.

parser

string

required

Parser type: file, yaml, properties, ini, json, xml, or toml.

create_new

boolean

default:"true"

Create the file if it does not exist.

replace

array

required

List of replacement rules.

config_startup

object

required

Startup detection configuration (log line pattern that signals the server is ready).

config_stop

object

required

Stop signal configuration.

config_script

object

required

Installation script configuration.

features

string[]

List of feature flags to enable for servers using this egg.

file_denylist

string[]

File paths that users cannot read or modify.

force_outgoing_ip

boolean

default:"false"

Force servers to use the node’s primary IP for outgoing connections.

separate_port

boolean

default:"false"

Assign a separate port for the Wings health check.

egg_repository_egg_uuid

string (UUID)

Optional link to an egg repository egg for update tracking.

Required admin permission: eggs.create

Update an egg

PATCH /api/admin/nests/{nest}/eggs/{egg}

Accepts the same body fields as the create endpoint. All fields are optional. Required admin permission: eggs.update

Import eggs

Import one or more eggs from a JSON export.

POST /api/admin/nests/{nest}/eggs/import

Required admin permission: eggs.create

Egg configurations

Egg configurations group eggs into deployment presets and control which allocations and routes are applied when a server is created.

List egg configurations

GET /api/admin/egg-configurations

page

integer

default:"1"

Page number.

per_page

integer

default:"10"

Items per page.

string

Filter by name.

Required admin permission: egg-configurations.read

Create an egg configuration

POST /api/admin/egg-configurations

name

string

required

Configuration name.

description

string

Optional description.

order

integer

Display order.

eggs

string[]

List of egg UUIDs to include in this configuration.

config_allocations

object

Allocation configuration rules.

config_routes

object

Route configuration rules.

Required admin permission: egg-configurations.create

Egg object fields

uuid

string

Egg UUID.

nest

object

The parent nest.

Show nest properties

uuid

string

Nest UUID.

name

string

Nest name.

author

string

Egg author identifier.

name

string

Egg display name.

description

string | null

Optional description.

startup_commands

object

Map of startup command labels to command strings.

docker_images

object

Map of image display names to Docker image references.

config_files

array

Configuration file rules applied at server startup.

config_startup

object

Startup detection configuration.

config_stop

object

Stop signal configuration.

config_script

object

Installation script configuration.

variables

array

List of egg variables.

Show variable properties

uuid

string

Variable UUID.

name

string

Variable display name.

description

string

Description of the variable’s purpose.

env_variable

string

Environment variable name used in the startup command.

default_value

string | null

Default value if not overridden on the server.

user_viewable

boolean

Whether the variable is visible to server owners.

user_editable

boolean

Whether server owners can change the value.

rules

string[]

Validation rules (e.g. required, numeric, min:1).

features

string[]

Enabled feature flags.

file_denylist

string[]

Files users cannot read or modify.

force_outgoing_ip

boolean

Whether outgoing connections are forced through the node’s primary IP.

created

string

ISO 8601 creation timestamp.

Overview

Client API

Admin API

Admin API: nest and egg configuration management

Nests

List nests

Get a nest

Create a nest

Update a nest

Delete a nest

Eggs

List eggs in a nest

Get an egg

Create an egg

Update an egg

Import eggs

Egg configurations

List egg configurations

Create an egg configuration

Egg object fields

Build docs developers (and LLMs) love

Overview

Client API

Admin API

Documentation Index

​Nests

​List nests

​Get a nest

​Create a nest

​Update a nest

​Delete a nest

​Eggs

​List eggs in a nest

​Get an egg

​Create an egg

​Update an egg

​Import eggs

​Egg configurations

​List egg configurations

​Create an egg configuration

​Egg object fields

Build docs developers (and LLMs) love

Nests

List nests

Get a nest

Create a nest

Update a nest

Delete a nest

Eggs

List eggs in a nest

Get an egg

Create an egg

Update an egg

Import eggs

Egg configurations

List egg configurations

Create an egg configuration

Egg object fields