Admin API: admin server management endpoints

The server management endpoints under /api/admin/servers give administrators full control over every server on the panel. They support creating servers from scratch, updating resource limits, managing allocations and variables, and deleting servers.

List servers

Returns a paginated list of all servers across all nodes and owners.

GET /api/admin/servers

page

integer

default:"1"

Page number.

per_page

integer

default:"10"

Items per page (1–100).

string

Filter by server name.

Required admin permission: servers.read

curl
Response

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

{
  "servers": {
    "data": [
      {
        "uuid": "abc12345-...",
        "name": "Minecraft SMP",
        "status": null,
        "suspended": false,
        "memory": 2048,
        "disk": 10240,
        "cpu": 100
      }
    ],
    "total": 1,
    "per_page": 10,
    "page": 1
  }
}

Get a server

Returns a single server by UUID or short ID.

GET /api/admin/servers/{server}

server

string

required

Server UUID or short numeric ID.

Required admin permission: servers.read

Create a server

Creates a new server and triggers installation on the target node.

POST /api/admin/servers

node_uuid

string (UUID)

required

UUID of the node to deploy to.

owner_uuid

string (UUID)

required

UUID of the user who will own the server.

egg_uuid

string (UUID)

required

UUID of the egg to use.

name

string

required

Server name. 3–255 characters.

description

string

Optional description. Maximum 1024 characters.

startup

string

required

Startup command. 1–8192 characters.

image

string

required

Docker image. 2–255 characters.

limits

object

required

Resource limits for the server.

Show limits properties

memory

integer

required

Memory limit in MiB. Use 0 for unlimited.

swap

integer

required

Swap limit in MiB. Use -1 to disable, 0 for unlimited.

disk

integer

required

Disk limit in MiB.

io_weight

integer

Block I/O weight (10–1000). Optional.

cpu

integer

required

CPU limit as a percentage. Use 0 for unlimited.

feature_limits

object

required

Allocation and feature limits.

Show feature_limits properties

allocation_limit

integer

required

Maximum additional allocations.

database_limit

integer

required

Maximum databases.

backup_limit

integer

required

Maximum backups.

schedule_limit

integer

required

Maximum schedules.

variables

array

Egg variable overrides.

Show variable object

env_variable

string

required

Environment variable name.

value

string

required

Value for this variable.

allocation_uuid

string (UUID)

Primary allocation UUID. If omitted, the panel assigns one from the node.

allocation_uuids

string[]

Additional allocation UUIDs to assign.

backup_configuration_uuid

string (UUID)

Optional backup configuration to apply.

start_on_completion

boolean

default:"false"

Start the server automatically after installation completes.

skip_installer

boolean

default:"false"

Skip the installation script.

external_id

string

Optional external identifier. Maximum 255 characters.

timezone

string

Timezone string (e.g. America/New_York).

hugepages_passthrough_enabled

boolean

default:"false"

Enable HugePages passthrough.

kvm_passthrough_enabled

boolean

default:"false"

Enable KVM passthrough.

pinned_cpus

integer[]

List of CPU cores to pin the server to.

Required admin permission: servers.create

Update a server

Updates configuration for an existing server. All body fields are optional.

PATCH /api/admin/servers/{server}

server

string

required

Server UUID or short ID.

The request body accepts the same fields as the create endpoint. Omitted fields are not changed. Required admin permission: servers.update After a successful update, the panel asynchronously syncs the new configuration to the Wings node.

Delete a server

Permanently deletes a server and removes it from the Wings node.

DELETE /api/admin/servers/{server}

server

string

required

Server UUID or short ID.

force

boolean

default:"false"

If true, proceeds with deletion even if the Wings node returns an error.

delete_backups

boolean

default:"false"

Also delete all backups associated with this server.

Required admin permission: servers.delete

This action is irreversible. The server’s files are permanently removed from the node.

Clear server state

Clears a stuck installation or backup-restore state.

POST /api/admin/servers/{server}/clear-state

server

string

required

Server UUID or short ID.

Required admin permission: servers.update

Server variables

List variables

GET /api/admin/servers/{server}/variables

Returns the egg variables and their current values for the server. Required admin permission: servers.read

Update a variable

PATCH /api/admin/servers/{server}/variables

env_variable

string

required

Environment variable name.

value

string

required

New value for the variable.

Required admin permission: servers.update

Server object fields

uuid

string

Full UUID of the server.

uuid_short

integer

Short numeric ID used in URLs.

external_id

string | null

Optional external identifier.

name

string

Server display name.

description

string | null

Optional description.

status

string | null

Installation status: installing, install_failed, restoring_backup, or null (ready).

suspended

boolean

Whether the server is suspended.

memory

integer

Memory limit in MiB.

swap

integer

Swap limit in MiB.

disk

integer

Disk limit in MiB.

cpu

integer

CPU limit as a percentage.

startup

string

Startup command template.

image

string

Docker image name.

node

object

The node this server is deployed on.

owner

object

The user who owns this server.

egg

object

The egg used by this server.

allocation

object | null

Primary IP/port allocation.

created

string

ISO 8601 creation timestamp.

Overview

Client API

Admin API

Admin API: admin server management endpoints

List servers

Get a server

Create a server

Update a server

Delete a server

Clear server state

Server variables

List variables

Update a variable

Server object fields

Build docs developers (and LLMs) love

Overview

Client API

Admin API

Documentation Index

​List servers

​Get a server

​Create a server

​Update a server

​Delete a server

​Clear server state

​Server variables

​List variables

​Update a variable

​Server object fields

Build docs developers (and LLMs) love

List servers

Get a server

Create a server

Update a server

Delete a server

Clear server state

Server variables

List variables

Update a variable

Server object fields