API Client Commands

bsm-api-client

A CLI for managing Bedrock servers.

Usage

bsm-api-client [OPTIONS] COMMAND [ARGS]...

account

Commands for managing your account.

Usage

bsm-api-client account [OPTIONS] COMMAND [ARGS]...

change-password

Change your password.

Usage

bsm-api-client account change-password [OPTIONS]

Options

--current-password <current_password>: Your current password.

--new-password <new_password>: Your new password.

details

Get your account details.

Usage

bsm-api-client account details [OPTIONS]

update-profile

Update your profile.

Usage

bsm-api-client account update-profile [OPTIONS]

Options

--full-name <full_name>: Your full name.

--email <email>: Your email address.

update-theme

Update your theme.

Usage

bsm-api-client account update-theme [OPTIONS]

Options

--theme <theme>: The name of the theme to set.

addon

Manages server addons.

Usage

bsm-api-client addon [OPTIONS] COMMAND [ARGS]...

install

Installs a behavior or resource pack addon to a specified server.

Usage

bsm-api-client addon install [OPTIONS]

Options

-s, --server <server_name>: Required Name of the target server.

-f, --file <addon_file_path>: Path to the addon file (.mcpack, .mcaddon); skips interactive menu.

allowlist

Manages a server’s player allowlist.

Usage

bsm-api-client allowlist [OPTIONS] COMMAND [ARGS]...

add

Adds one or more players to a server’s allowlist.

Usage

bsm-api-client allowlist add [OPTIONS]

Options

-s, --server <server_name>: Required The name of the server.

-p, --player <players>: Gamertag of the player to add. Use multiple times for multiple players.

--ignore-limit: Allow player(s) to join even if the server is full.

list

Lists all players currently on a server’s allowlist.

Usage

bsm-api-client allowlist list [OPTIONS]

Options

-s, --server <server_name>: Required The name of the server.

remove

Removes one or more players from a server’s allowlist.

Usage

bsm-api-client allowlist remove [OPTIONS]

Options

-s, --server <server_name>: Required The name of the server.

-p, --player <players>: Required Gamertag of the player to remove. Use multiple times for multiple players.

auth

Manages authentication.

Usage

bsm-api-client auth [OPTIONS] COMMAND [ARGS]...

login

Logs in to the Bedrock Server Manager API.

Usage

bsm-api-client auth login [OPTIONS]

Options

--base-url <base_url>: The base URL of the Bedrock Server Manager API.

--verify-ssl, --no-verify-ssl: Enable/disable SSL verification.

--username <username>: The username for authentication.

--password <password>: The password for authentication.

--token <token>: The JWT token for authentication.

logout

Logs out from the Bedrock Server Manager API.

Usage

bsm-api-client auth logout [OPTIONS]

backup

Manages server backups.

Usage

bsm-api-client backup [OPTIONS] COMMAND [ARGS]...

create

Creates a backup of specified server data.

Usage

bsm-api-client backup create [OPTIONS]

Options

-s, --server <server_name>: Required Name of the target server.

-t, --type <backup_type>

Type of backup to create; skips interactive menu.

Options:: world | config | all

-f, --file <file_to_backup>: Specific file to back up (required if –type=config).

prune

Deletes old backups for a server.

Usage

bsm-api-client backup prune [OPTIONS]

Options

-s, --server <server_name>: Required Name of the server whose backups to prune.

restore

Restores server data from a specified backup file.

Usage

bsm-api-client backup restore [OPTIONS]

Options

-s, --server <server_name>: Required Name of the target server.

-f, --file <backup_file_path>: Path to the backup file to restore; skips interactive menu.

content

Commands for managing content.

Usage

bsm-api-client content [OPTIONS] COMMAND [ARGS]...

upload

Upload a content file.

Usage

bsm-api-client content upload [OPTIONS] FILE_PATH

Arguments

FILE_PATH: Required argument

permissions

Manages player permission levels on a server.

Usage

bsm-api-client permissions [OPTIONS] COMMAND [ARGS]...

list

Lists all configured player permissions for a specific server.

Usage

bsm-api-client permissions list [OPTIONS]

Options

-s, --server <server_name>: Required The name of the server.

set

Sets a permission level for a player on a specific server.

Usage

bsm-api-client permissions set [OPTIONS]

Options

-s, --server <server_name>: Required The name of the target server.

-p, --player <player_name>: The gamertag of the player. Skips interactive mode.

-l, --level <level>

The permission level to grant. Skips interactive mode.

Options:: visitor | member | operator

player

Manages the central player database.

Usage

bsm-api-client player [OPTIONS] COMMAND [ARGS]...

add

Manually adds or updates player entries in the central player database.

Usage

bsm-api-client player add [OPTIONS]

Options

-p, --player <players>: Required Player to add in ‘Gamertag:XUID’ format. Use multiple times for multiple players.

scan

Scans all server logs to discover player gamertags and XUIDs.

Usage

bsm-api-client player scan [OPTIONS]

plugin

Manages plugins.

Usage

bsm-api-client plugin [OPTIONS] COMMAND [ARGS]...

disable

Disables a plugin.

Usage

bsm-api-client plugin disable [OPTIONS] PLUGIN_NAME

Arguments

PLUGIN_NAME: Required argument

enable

Enables a plugin.

Usage

bsm-api-client plugin enable [OPTIONS] PLUGIN_NAME

Arguments

PLUGIN_NAME: Required argument

list

Lists all discoverable plugins.

Usage

bsm-api-client plugin list [OPTIONS]

reload

Reloads all plugins.

Usage

bsm-api-client plugin reload [OPTIONS]

trigger-event

Triggers a custom plugin event.

Usage

bsm-api-client plugin trigger-event [OPTIONS] EVENT_NAME

Options

--payload-json <payload_json>: Optional JSON string to use as the event payload.

Arguments

EVENT_NAME: Required argument

properties

Manages a server’s server.properties file.

Usage

bsm-api-client properties [OPTIONS] COMMAND [ARGS]...

get

Displays server properties from a server’s server.properties file.

Usage

bsm-api-client properties get [OPTIONS]

Options

-s, --server <server_name>: Required The name of the target server.

-p, --prop <property_name>: Display a single property value.

set

Sets one or more properties in a server’s server.properties file.

Usage

bsm-api-client properties set [OPTIONS]

Options

-s, --server <server_name>: Required The name of the target server.

-p, --prop <properties>: A ‘key=value’ pair to set. Use multiple times for multiple properties.

server

Manages servers.

Usage

bsm-api-client server [OPTIONS] COMMAND [ARGS]...

delete

Deletes all data for a server, including world, configs, and backups.

Usage

bsm-api-client server delete [OPTIONS]

Options

-s, --server <server_name>: Required Name of the server to delete.

-y, --yes: Bypass the confirmation prompt.

install

Guides you through installing and configuring a new Bedrock server instance.

Usage

bsm-api-client server install [OPTIONS]

list

Lists all configured Bedrock servers and their current operational status.

Usage

bsm-api-client server list [OPTIONS]

Options

--loop: Continuously refresh server statuses every 5 seconds.

--server-name <server_name>: Display status for only a specific server.

restart

Gracefully restarts a specific Bedrock server.

Usage

bsm-api-client server restart [OPTIONS]

Options

-s, --server <server_name>: Required Name of the server to restart.

send-command

Sends a command to a running Bedrock server’s console.

Usage

bsm-api-client server send-command [OPTIONS] COMMAND_PARTS...

Options

-s, --server <server_name>: Required Name of the target server.

Arguments

COMMAND_PARTS: Required argument(s)

start

Starts a specific Bedrock server instance.

Usage

bsm-api-client server start [OPTIONS]

Options

-s, --server <server_name>: Required Name of the server to start.

stop

Sends a graceful stop command to a running Bedrock server.

Usage

bsm-api-client server stop [OPTIONS]

Options

-s, --server <server_name>: Required Name of the server to stop.

update

Checks for and applies updates to an existing Bedrock server.

Usage

bsm-api-client server update [OPTIONS]

Options

-s, --server <server_name>: Required Name of the server to update.

system

Manages OS-level integrations and server resource monitoring.

Usage

bsm-api-client system [OPTIONS] COMMAND [ARGS]...

configure-service

Configures OS-specific service settings for a Bedrock server.

Usage

bsm-api-client system configure-service [OPTIONS]

Options

-s, --server <server_name>: Required Name of the server to configure.

disable-service

Disables a server’s system service from starting automatically.

Usage

bsm-api-client system disable-service [OPTIONS]

Options

-s, --server <server_name>: Required Name of the server service to disable.

enable-service

Enables a server’s system service for automatic startup.

Usage

bsm-api-client system enable-service [OPTIONS]

Options

-s, --server <server_name>: Required Name of the server service to enable.

monitor

Continuously monitors CPU and memory usage of a specific server process.

Usage

bsm-api-client system monitor [OPTIONS]

Options

-s, --server <server_name>: Required Name of the server to monitor.

world

Manages server worlds.

Usage

bsm-api-client world [OPTIONS] COMMAND [ARGS]...

export

Exports the server’s current active world to a .mcworld file.

Usage

bsm-api-client world export [OPTIONS]

Options

-s, --server <server_name>: Required Name of the server whose world to export.

install

Installs a world from a .mcworld file, replacing the server’s current world.

Usage

bsm-api-client world install [OPTIONS]

Options

-s, --server <server_name>: Required Name of the target server.

-f, --file <world_file_path>: Path to the .mcworld file to install. Skips interactive menu.

reset

Deletes the current active world data for a server.

Usage

bsm-api-client world reset [OPTIONS]

Options

-s, --server <server_name>: Required Name of the server whose world to reset.

-y, --yes: Bypass the confirmation prompt.