Server Console

Execute server console command

Execute a single server debug console command and return its complete output. Intended for integrations; interactive terminals should use POST /v1/server-console/session to receive output as it is produced.

Output is returned as plain text with terminal color sequences removed. Unknown or failed commands are reported in the output text, not by HTTP status. The down command initiates server shutdown after the response is sent. The exit command has no effect.

Requires SERVER_CONSOLE access right.

post/v1/server-console/execute

Request body

commandstring required

Console command line

Response

Command executed

outputstring

Command output

shutdownInitiatedboolean

True if the command initiated server shutdown

Changes

Changed in 1 of the 128 revisions of this API.1