Overview
Nests are categories that group related eggs (server types). For example, a “Minecraft” nest might contain eggs for Vanilla, Spigot, Paper, etc.
Endpoints
List Nests
curl -X GET "https://panel.example.com/api/admin/nests" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Accept: application/json"
nests:read permission
Query Parameters:
view (optional): Set to options for a simplified list of ID and name only
Response (default):
{
"data": [
{
"id": "nest-uuid",
"uuid": "nest-uuid",
"author": "[email protected]",
"name": "Minecraft",
"description": "Minecraft servers",
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z",
"eggCount": 12
}
]
}
{
"data": [
{
"id": "nest-uuid",
"name": "Minecraft"
}
]
}
Get Nest
curl -X GET "https://panel.example.com/api/admin/nests/nest-uuid" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Accept: application/json"
Create Nest
curl -X POST "https://panel.example.com/api/admin/nests" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Custom Games",
"description": "Custom game server nest",
"author": "[email protected]"
}'
name (required): Nest name (1-255 characters, trimmed)description (optional): Description (max 500 characters, trimmed)author (required): Author identifier (minimum 1 character, trimmed)
Update Nest
curl -X PATCH "https://panel.example.com/api/admin/nests/nest-uuid" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"description": "Updated description"
}'
Delete Nest
curl -X DELETE "https://panel.example.com/api/admin/nests/nest-uuid" \
-H "Authorization: Bearer YOUR_API_KEY"
Nest Object
Author email or identifier
Number of eggs in this nest (only in list endpoint)
Notes
- Nests are ordered alphabetically by name
- The
eggCount is computed via SQL join in the list endpoint
- Use
view=options for dropdown/select inputs in UIs
- Audit logs are created for all nest operations