BoxToPlay

Execute one read-only Minecraft Public API action selected by its exact action_id.

minecraft_execute_read_action

Executes one ServerQuery command on an online virtual server with the selected account and returns its output.

teamspeak_execute_server_query_command

Execute one non-read TeamSpeak Public API action selected by its exact action_id.

teamspeak_execute_mutation

Execute one read-only TeamSpeak Public API action selected by its exact action_id.

teamspeak_execute_read_action

Executes a Linux shell or Windows PowerShell command with administrative system privileges on a started VPS, waits for completion, and returns its exit code and output. Use this endpoint for commands expected to finish within 105 seconds; use the asynchronous endpoint for longer operations. An HTTP 200 response means the process was launched and its result was collected, not that the command exited successfully. Treat the command as successful only when exit_code is 0, timed_out is false, and output_truncated is false. When output_truncated is true, stdout and stderr may be incomplete. For Linux, use POSIX /bin/sh-compatible scripts. Prefer a quoted heredoc for literal HTML or configuration content, and avoid sed for arbitrary replacements containing special characters. Use set -e or && when later steps must stop after a failure. A collected command result is successful only when exit_code is 0, timed_out is false, and output_truncated is false. After any other terminal result, submit a corrected command instead of repeating the identical command.

vps_execute_command

Queues a Linux shell or Windows PowerShell command with administrative system privileges and returns an HTTP 202 response without waiting for completion. The VPS must be started when execution begins. Poll status_url until status is succeeded or failed. A succeeded command job includes command_result. A non-zero exit_code or timed_out=true still represents a collected command result. Treat the command as successful only when exit_code is 0, timed_out is false, and output_truncated is false. When output_truncated is true, stdout and stderr may be incomplete. A failed job means no completed command result could be confirmed; do not assume the command made no changes. For Linux, use POSIX /bin/sh-compatible scripts. Prefer a quoted heredoc for literal HTML or configuration content, and avoid sed for arbitrary replacements containing special characters. Use set -e or && when later steps must stop after a failure. A collected command result is successful only when exit_code is 0, timed_out is false, and output_truncated is false. The initial result is a job: poll it with service_get_job until it reaches a terminal state. Only after the terminal command_result is unsuccessful or unconfirmed should you submit a corrected command instead of repeating the identical command.

vps_execute_command_async

Returns recent live log lines in chronological order. Omit cursor for the initial result, then use next_cursor to continue.

bungee_get_live_logs

Returns an inclusive chronological line window from the selected log file. Line numbering starts at 1.

bungee_get_log_file_lines

BungeeCord / Velocity player counts, CPU and memory usage, and total disk usage in bytes. Raw CPU usage is a percentage where 100 represents one logical CPU core and values can exceed 100. The response also provides the bounded CPU value and memory capacity used by BoxToPlay interfaces. Memory usage and its display capacity are expressed in megabytes.

bungee_get_metrics

When sorted by popularity, channels are ordered by connected client count and clients by channel activity.

teamspeak_get_live_view

TeamSpeak client counts and network traffic over the last minute. Network values are expressed in bytes.

teamspeak_get_metrics

Returns the VPS connection settings.

vps_get_settings

Returns the VPS details and its published catalog plan when available.

vps_get_server

Returns VPS resource limits, live metrics and chronological history for the requested timeframe. CPU values are percentages. Memory, network and disk values use bytes. Historical network and disk values are expressed in bytes per second.

vps_get_metrics

Returns the most recent chronological lines from the selected log file.

bungee_get_log_file

Returns a paginated list of log files. Use each returned file id with the log file endpoints.

bungee_list_log_files

List BungeeCord / Velocity servers available to the authenticated BoxToPlay account.

bungee_list_servers

List the available Minecraft server backups.

minecraft_list_backups

List the available Minecraft server log files and return identifiers for the log reading tools.

minecraft_list_log_files

List Minecraft servers available to the authenticated BoxToPlay account.

minecraft_list_servers

Returns the Mumble Lite services.

lite_list_mumble_services

Returns the MySQL Lite services.

lite_list_mysql_services

Lists the ServerQuery accounts available for command execution.

teamspeak_list_server_query_accounts

Returns the TeamSpeak backups.

teamspeak_list_backups

List TeamSpeak servers available to the authenticated BoxToPlay account.

teamspeak_list_servers

Returns the VPS backups.

vps_list_backups

Returns the VPS firewall rules.

vps_list_firewall_rules

Returns the VPS operating systems available for reinstallation.

vps_list_operating_systems

List VPS servers available to the authenticated BoxToPlay account.

vps_list_servers

Returns the Web Hosting Lite services.

lite_list_web_hosting_services

List the editable text files and folders of a Minecraft server.

minecraft_list_editable_files

List asynchronous service operations for the authenticated account.

service_list_jobs

Read the AI credit balance for the authenticated BoxToPlay account.

account_get_ai_credit

Read the current runtime status of a BungeeCord / Velocity server.

bungee_get_status

Read recent live log lines for a Minecraft server.

minecraft_get_live_logs

Read a line range from a Minecraft server log file selected with an id returned by minecraft_list_log_files.

minecraft_get_log_file_lines

Read the current structured health diagnostics for a Minecraft server.

minecraft_get_health

Read the current runtime status of a Minecraft server.

minecraft_get_status

Read the current runtime status of a TeamSpeak server.

teamspeak_get_status

Read the current runtime status of a VPS server.

vps_get_status