Pterodactyl WebSocketInstall

Summary

Request server resource statistics via Pterodactyl's WebSocket API for a specified server, waiting up to a defined timeout period for the response.

Inputs

• Server (required) — Select the server to retrieve logs and stats from; options are dynamically loaded from your Pterodactyl client servers.
• Timeout (ms) — Set the maximum time in milliseconds to wait for the stats response (default is 5000 ms).

Output shape

a JSON object containing the server statistics received from the Pterodactyl WebSocket API

If the request times out or errors occur, the operation may return an error object if 'Continue On Fail' is enabled; otherwise, it will throw an error.

Examples

Example 1: Use this operation to monitor real-time resource usage such as CPU, memory, and network stats for a specific Pterodactyl server by selecting that server and configuring the optional response timeout.

Set 'Server' to the desired server identifier, and optionally adjust 'Timeout (ms)' to control how long the node waits for a response before failing.