Skip to main content
POST
/
api
/
admin
/
servers
/
:id
/
actions
curl -X POST "https://panel.example.com/api/admin/servers/a1b2c3d4/actions" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"action": "start"}'

{
  "data": {
    "success": true,
    "message": "Server start action completed successfully"
  }
}

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/xyrapanel/panel/llms.txt

Use this file to discover all available pages before exploring further.

​
Authentication

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

​
Path Parameters

​
id
string
required
Server ID or UUID

​
Request Body

​
action
string
required
Action to perform. One of:
  • start - Start the server
  • stop - Stop the server gracefully
  • restart - Restart the server
  • kill - Force kill the server process
  • suspend - Suspend the server
  • unsuspend - Unsuspend the server
  • reinstall - Reinstall the server
  • delete - Delete the server

​
Response

​
data
object
curl -X POST "https://panel.example.com/api/admin/servers/a1b2c3d4/actions" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"action": "start"}'

{
  "data": {
    "success": true,
    "message": "Server start action completed successfully"
  }
}

​
Action Details

​
Power Actions

  • start: Starts the server if it’s stopped
  • stop: Sends a graceful shutdown signal
  • restart: Stops and then starts the server
  • kill: Force terminates the server process (use with caution)

​
Management Actions

  • suspend: Prevents the server from starting and stops it if running
  • unsuspend: Removes suspension and allows the server to start
  • reinstall: Triggers a fresh installation of the server
  • delete: Deletes the server entirely

​
Error Responses

  • 403 Forbidden: Wings authentication failed
  • 503 Service Unavailable: Wings daemon is unavailable
  • 500 Internal Server Error: Action failed for other reasons

Build docs developers (and LLMs) love

Get started for freeTalk to us