Skip to main content
POST
/
api
/
admin
/
nodes
Create Node
curl --request POST \
  --url https://api.example.com/api/admin/nodes \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "locationId": "<string>",
  "fqdn": "<string>",
  "scheme": "<string>",
  "behindProxy": true,
  "public": true,
  "maintenanceMode": true,
  "memory": 123,
  "memoryOverallocate": 123,
  "disk": 123,
  "diskOverallocate": 123,
  "daemonBase": "<string>",
  "daemonSftp": 123,
  "daemonListen": 123,
  "uploadSize": 123
}
'
Node creation is typically done through the Wings-specific endpoints at /api/admin/wings/nodes. This endpoint may be available in future versions.

​
Authentication

This endpoint requires admin authentication and the nodes:write permission.

​
Request Body

​
name
string
required
Node name (1-255 characters)
​
locationId
string
required
UUID of the location to assign this node to
​
fqdn
string
required
Fully qualified domain name or IP address (1-255 characters)
​
scheme
string
default:"https"
Connection scheme: http or https
​
behindProxy
boolean
default:"false"
Whether the node is behind a proxy (affects IP detection)
​
public
boolean
default:"true"
Whether the node is publicly accessible
​
maintenanceMode
boolean
default:"false"
Whether the node is in maintenance mode
​
memory
integer
required
Total memory in MB (must be positive)
​
memoryOverallocate
integer
default:"0"
Memory overallocation percentage (minimum: -1, -1 = unlimited)
​
disk
integer
required
Total disk space in MB (must be positive)
​
diskOverallocate
integer
default:"0"
Disk overallocation percentage (minimum: -1, -1 = unlimited)
​
daemonBase
string
default:"/var/lib/pterodactyl/volumes"
Base directory for server files
​
daemonSftp
integer
default:"2022"
SFTP port (1-65535)
​
daemonListen
integer
default:"8080"
Wings daemon listen port (1-65535)
​
uploadSize
integer
default:"100"
Maximum upload size in MB (must be positive)

​
Notes

  • After creating a node, you’ll need to configure Wings on the target server
  • Generate a configuration token using the node’s configuration endpoint
  • Ensure the FQDN is resolvable and Wings is accessible from the panel

Build docs developers (and LLMs) love

Get started for freeTalk to us