Pterodactyl WebSocketInstall

Summary

Send a console command to a specified Pterodactyl server via WebSocket, optionally waiting for and returning the server's console output response.

Inputs

• Server (required) — Select the server to control from your available Pterodactyl client servers.
• Command (required) — Enter the console command string to execute on the selected server.
• Wait for Response — Boolean to determine if the operation should wait for the server's console output response after sending the command.
• Response Timeout (ms) — Set the maximum time in milliseconds to wait for a console output response when 'Wait for Response' is enabled. Defaults to 5000 ms.

Output shape

a list of items, each containing JSON with console output responses or command execution results

If 'Wait for Response' is true, the response includes the server's console output or results within the given timeout. If false, results are sent without waiting for a response. Errors in command sending are included as error messages in the output JSON.

Examples

Example 1: Send a simple command without waiting for response

Set Server to target server, Command to a command string (e.g., 'say Hello World'), and keep 'Wait for Response' disabled.

Example 2: Send a command and wait for output

Enable 'Wait for Response' and optionally set 'Response Timeout (ms)' to control how long to wait for the server's console output in response to the command.