Send Commands

POST /api/servers/:server/commands

Send Commands

cURL

curl --request POST \
  --url https://api.example.com/api/servers/:server/commands \
  --header 'Content-Type: application/json' \
  --data '
{
  "commands": [
    {}
  ]
}
'

import requests

url = "https://api.example.com/api/servers/:server/commands"

payload = { "commands": [{}] }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({commands: [{}]})
};

fetch('https://api.example.com/api/servers/:server/commands', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/servers/:server/commands",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'commands' => [
        [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/servers/:server/commands"

	payload := strings.NewReader("{\n  \"commands\": [\n    {}\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/servers/:server/commands")
  .header("Content-Type", "application/json")
  .body("{\n  \"commands\": [\n    {}\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/servers/:server/commands")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"commands\": [\n    {}\n  ]\n}"

response = http.request(request)
puts response.read_body

Sends one or more commands to a running server instance.

Authentication

Requires the Wings authentication token in the Authorization header:

Authorization: Bearer <token>

Path Parameters

server · string · required

The UUID of the server

Request Body

commands · array · required

Array of command strings to send to the server. Each command is sent sequentially.

Response

Returns 204 No Content when commands have been sent successfully.

Error Responses

404 Not Found

The requested server does not exist on this Wings instance.

502 Bad Gateway

Cannot send commands to a stopped server instance.

500 Internal Server Error

An error occurred while checking if the server is running.

Behavior

• Checks if the server is running before sending commands
• If the server is not running, returns a 502 error
• Commands are sent sequentially in the order provided
• If a command fails to send, an error is logged but subsequent commands are still attempted
• Command failures do not cause the API request to fail

Example Request

curl -X POST https://wings.example.com/api/servers/8d3f9a2e-5c7b-4f1e-9d2a-6e8f1c3b5a7d/commands \
  -H "Authorization: Bearer your-wings-token" \
  -H "Content-Type: application/json" \
  -d '{
    "commands": [
      "say Server maintenance in 5 minutes",
      "save-all",
      "whitelist add PlayerName"
    ]
  }'

Example Response

HTTP/1.1 204 No Content

Notes

• Commands are executed in the server’s console/stdin
• The server must be in a running state (not offline, starting, or stopping)
• Individual command failures are logged but don’t fail the entire request
• There is no response body indicating which commands succeeded or failed
• Commands are sent to the environment (Docker container) via stdin

Source Reference

Implemented in router/router_server.go:108