Available APIs
This was auto-generated by the
api_docs_generatorplugin on 2026-06-23 06:43:11 UTC. Application Version: 3.10.0b1
This lists contains all functions available to plugins via the self.api object.
For an updated list of available APIs, please download and run the api_docs_generator plugin.
add_players_manually_api
self.api.add_players_manually_api(player_strings: List[str], app_context: bedrock_server_manager.context.AppContext)
Description: Adds or updates player data in the database.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
add_server_ban_api
self.api.add_server_ban_api(app_context: bedrock_server_manager.context.AppContext, server_name: str, player_name: str, xuid: str, reason: str | None = None)
Description: Adds a player to the server ban list.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
`str |
None` |
add_to_allowlist
self.api.add_to_allowlist(server_name: str, new_players_data: List[Dict[str, Any]], app_context: bedrock_server_manager.context.AppContext)
Description: Adds a list of players to the server’s allowlist.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
backup_all
self.api.backup_all(server_name: str, app_context: bedrock_server_manager.context.AppContext, stop_start_server: bool = True)
Description: Performs a full backup of the server’s world and configuration files.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
backup_config_file
self.api.backup_config_file(server_name: str, file_to_backup: str, app_context: bedrock_server_manager.context.AppContext, stop_start_server: bool = True)
Description: Creates a backup of a specific server configuration file.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
backup_world
self.api.backup_world(server_name: str, app_context: bedrock_server_manager.context.AppContext, stop_start_server: bool = True)
Description: Creates a backup of the server’s world directory.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
disable_addon
self.api.disable_addon(server_name: str, pack_uuid: str, pack_type: str, app_context: bedrock_server_manager.context.AppContext)
Description: Disables an active addon for a server’s active world, preserving files.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
enable_addon
self.api.enable_addon(server_name: str, pack_uuid: str, pack_type: str, app_context: bedrock_server_manager.context.AppContext)
Description: Enables a disabled addon for a server’s active world.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
export_world
self.api.export_world(server_name: str, app_context: bedrock_server_manager.context.AppContext, export_dir: str | None = None, stop_start_server: bool = True)
Description: Exports the server’s currently active world to a .mcworld archive.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
`str |
None` |
|
|
|
get_all_global_settings
self.api.get_all_global_settings(app_context: bedrock_server_manager.context.AppContext)
Description: Reads the entire global application settings configuration.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
get_all_known_players_api
self.api.get_all_known_players_api(app_context: bedrock_server_manager.context.AppContext)
Description: Retrieves all player data from the database.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
get_all_server_settings
self.api.get_all_server_settings(server_name: str, app_context: bedrock_server_manager.context.AppContext)
Description: Reads the entire JSON configuration for a specific server from its
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
get_all_servers_data
self.api.get_all_servers_data(app_context: bedrock_server_manager.context.AppContext)
Description: Retrieves status and version for all detected servers.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
get_allowlist
self.api.get_allowlist(server_name: str, app_context: bedrock_server_manager.context.AppContext)
Description: Retrieves the current allowlist for a given server.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
get_bedrock_process_info
self.api.get_bedrock_process_info(server_name: str, app_context: bedrock_server_manager.context.AppContext)
Description: Retrieves resource usage for a running Bedrock server process.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
get_global_setting
self.api.get_global_setting(key: str, app_context: bedrock_server_manager.context.AppContext)
Description: Reads a single value from the global application settings.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
get_permissions
self.api.get_permissions(server_name: str, app_context: bedrock_server_manager.context.AppContext)
Description: Retrieves the permissions configuration for a server, formatted with player names.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
get_plugin_statuses
self.api.get_plugin_statuses(app_context: bedrock_server_manager.context.AppContext)
Description: Retrieves the statuses and metadata of all discovered plugins.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
get_properties
self.api.get_properties(server_name: str, app_context: bedrock_server_manager.context.AppContext)
Description: Retrieves the current server properties for a given server.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
get_server_bans_api
self.api.get_server_bans_api(app_context: bedrock_server_manager.context.AppContext, server_name: str)
Description: Retrieves all bans for a specific server.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
get_server_running_status
self.api.get_server_running_status(server_name: str, app_context: bedrock_server_manager.context.AppContext)
Description: Checks if the server process is currently running.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
get_server_setting
self.api.get_server_setting(server_name: str, key: str, app_context: bedrock_server_manager.context.AppContext)
Description: Reads any value from a server’s specific JSON configuration file
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
get_server_summary
self.api.get_server_summary(server_name: str, app_context: bedrock_server_manager.context.AppContext)
Description: Retrieves the summary information for a specific server.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
get_system_and_app_info
self.api.get_system_and_app_info(app_context: bedrock_server_manager.context.AppContext)
Description: Retrieves basic system and application information.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
get_web_server_status
self.api.get_web_server_status(app_context: bedrock_server_manager.context.AppContext)
Description: Checks the status of the web server process.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
get_web_ui_service_status
self.api.get_web_ui_service_status(app_context: bedrock_server_manager.context.AppContext, system: bool = False)
Description: Gets the current status of the Web UI system service.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
get_world_name
self.api.get_world_name(server_name: str, app_context: bedrock_server_manager.context.AppContext)
Description: Retrieves the configured world name (level-name) for a server.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
import_addon
self.api.import_addon(server_name: str, addon_file_path: str, app_context: bedrock_server_manager.context.AppContext, stop_start_server: bool = True, restart_only_on_success: bool = True)
Description: Installs an addon to a specified Bedrock server.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
import_world
self.api.import_world(server_name: str, selected_file_path: str, app_context: bedrock_server_manager.context.AppContext, stop_start_server: bool = True)
Description: Imports a world from a .mcworld file, replacing the active world.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
install_new_server
self.api.install_new_server(server_name: str, app_context: bedrock_server_manager.context.AppContext, target_version: str = 'LATEST', server_zip_path: str | None = None)
Description: Installs a new server instance.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
`str |
None` |
list_available_addons
self.api.list_available_addons(app_context: bedrock_server_manager.context.AppContext)
Description: Lists available .mcaddon and .mcpack files from the content directory.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
list_available_worlds_api
self.api.list_available_worlds_api(app_context: bedrock_server_manager.context.AppContext)
Description: Lists available .mcworld files from the content directory.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
list_backup_files
self.api.list_backup_files(server_name: str, backup_type: str, app_context: bedrock_server_manager.context.AppContext)
Description: Lists available backup files for a given server and type.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
list_installed_addons
self.api.list_installed_addons(server_name: str, app_context: bedrock_server_manager.context.AppContext)
Description: Lists all addons for a server’s active world.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
prune_download_cache
self.api.prune_download_cache(download_dir: str, keep_count: int | None = None, app_context: bedrock_server_manager.context.AppContext | None = None)
Description: Prunes old downloaded server archives (.zip) in a directory.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
`int |
None` |
|
`bedrock_server_manager.context.AppContext |
None` |
prune_old_backups
self.api.prune_old_backups(server_name: str, app_context: bedrock_server_manager.context.AppContext)
Description: Prunes old backups for a server based on retention settings.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
remove_from_allowlist
self.api.remove_from_allowlist(server_name: str, player_names: List[str], app_context: bedrock_server_manager.context.AppContext)
Description: Removes a list of players from the server’s allowlist.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
reorder_addons
self.api.reorder_addons(server_name: str, uuids: list[str], pack_type: str, app_context: bedrock_server_manager.context.AppContext)
Description: Reorders the active addons for a server’s active world.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
restart_server
self.api.restart_server(server_name: str, app_context: bedrock_server_manager.context.AppContext, send_message: bool = True)
Description: Restarts the specified Bedrock server by orchestrating stop and start.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
restore_all
self.api.restore_all(server_name: str, app_context: bedrock_server_manager.context.AppContext, stop_start_server: bool = True)
Description: Restores the server from the latest available backups.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
restore_config_file
self.api.restore_config_file(server_name: str, backup_file_path: str, app_context: bedrock_server_manager.context.AppContext, stop_start_server: bool = True)
Description: Restores a specific config file from a backup.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
restore_world
self.api.restore_world(server_name: str, backup_file_path: str, app_context: bedrock_server_manager.context.AppContext, stop_start_server: bool = True)
Description: Restores a server’s world from a specific backup file.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
scan_and_update_player_db_api
self.api.scan_and_update_player_db_api(app_context: bedrock_server_manager.context.AppContext)
Description: Scans all server logs to discover and save player data.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
send_command
self.api.send_command(server_name: str, command: str, app_context: bedrock_server_manager.context.AppContext)
Description: Sends a command to a running Bedrock server.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
server_lifecycle_manager
self.api.server_lifecycle_manager(server_name: str, stop_before: bool, app_context: bedrock_server_manager.context.AppContext, start_after: bool = True, restart_on_success_only: bool = False)
Description: A context manager to safely stop and restart a server for an operation.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
set_custom_global_setting
self.api.set_custom_global_setting(key: str, value: Any, app_context: bedrock_server_manager.context.AppContext)
Description: Writes a custom value to the global application settings.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
set_permissions
self.api.set_permissions(server_name: str, xuid: str, player_name: str | None, permission: str, app_context: bedrock_server_manager.context.AppContext)
Description: Sets a player’s permission level for a given server.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
`str |
None` |
|
|
|
|
|
|
set_properties
self.api.set_properties(server_name: str, properties_to_update: Dict[str, str], app_context: bedrock_server_manager.context.AppContext, restart_after_modify: bool = False)
Description: Sets one or multiple server properties for a given server.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
set_server_custom_value
self.api.set_server_custom_value(server_name: str, key: str, value: Any, app_context: bedrock_server_manager.context.AppContext)
Description: Writes a key-value pair to the ‘custom’ section of a server’s specific
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
start_server
self.api.start_server(server_name: str, app_context: bedrock_server_manager.context.AppContext)
Description: Starts the specified Bedrock server.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
stop_server
self.api.stop_server(server_name: str, app_context: bedrock_server_manager.context.AppContext)
Description: Stops the specified Bedrock server.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
update_server
self.api.update_server(server_name: str, app_context: bedrock_server_manager.context.AppContext, send_message: bool = True)
Description: Updates an existing server instance.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
validate_property_value
self.api.validate_property_value(property_name: str, value: str)
Description: Validates a specific server property value before it gets applied.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|