Available APIs
This was auto-generated by the
api_docs_generatorplugin on 2025-07-16 00:43:52 UTC. Application Version: 3.5.2
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])
Description: Adds or updates player data in the central players.json file.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
add_players_to_allowlist_api
self.api.add_players_to_allowlist_api(server_name: str, new_players_data: List[Dict[str, Any]])
Description: Adds new players to the allowlist for a specific server.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
backup_all
self.api.backup_all(server_name: str, 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, 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, stop_start_server: bool = True)
Description: Creates a backup of the server’s world directory.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
configure_player_permission
self.api.configure_player_permission(server_name: str, xuid: str, player_name: Optional[str], permission: str)
Description: Sets a player’s permission level in permissions.json.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
export_world
self.api.export_world(server_name: str, export_dir: Optional[str] = None, stop_start_server: bool = True)
Description: Exports the server’s currently active world to a .mcworld archive.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
get_all_global_settings
self.api.get_all_global_settings()
Description: Reads the entire global application settings configuration.
get_all_known_players_api
self.api.get_all_known_players_api()
Description: Retrieves all player data from the central players.json file.
get_all_server_settings
self.api.get_all_server_settings(server_name: str)
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()
Description: Retrieves status and version for all detected servers.
get_application_info_api
self.api.get_application_info_api()
Description: Retrieves general information about the application.
get_bedrock_process_info
self.api.get_bedrock_process_info(server_name: str)
Description: Retrieves resource usage for a running Bedrock server process.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
get_global_setting
self.api.get_global_setting(key: str)
Description: Reads a single value from the global application settings.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
get_plugin_statuses
self.api.get_plugin_statuses()
Description: Retrieves the statuses and metadata of all discovered plugins.
get_server_allowlist_api
self.api.get_server_allowlist_api(server_name: str)
Description: Retrieves the allowlist for a specific server.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
get_server_config_status
self.api.get_server_config_status(server_name: str)
Description: Gets the status from the server’s configuration file.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
get_server_installed_version
self.api.get_server_installed_version(server_name: str)
Description: Gets the installed version from the server’s configuration file.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
get_server_permissions_api
self.api.get_server_permissions_api(server_name: str)
Description: Retrieves processed permissions data for a server.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
get_server_properties_api
self.api.get_server_properties_api(server_name: str)
Description: Reads and returns the server.properties file for a server.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
get_server_running_status
self.api.get_server_running_status(server_name: str)
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)
Description: Reads any value from a server’s specific JSON configuration file
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
get_system_and_app_info
self.api.get_system_and_app_info()
Description: Retrieves basic system and application information.
get_web_server_status
self.api.get_web_server_status()
Description: Checks the status of the web server process.
get_world_name
self.api.get_world_name(server_name: str)
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, 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, 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, target_version: str = 'LATEST', server_zip_path: Optional[str] = None)
Description: Installs a new Bedrock server.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
list_available_addons_api
self.api.list_available_addons_api()
Description: Lists available .mcaddon and .mcpack files from the content directory.
list_available_worlds_api
self.api.list_available_worlds_api()
Description: Lists available .mcworld files from the content directory.
list_backup_files
self.api.list_backup_files(server_name: str, backup_type: str)
Description: Lists available backup files for a given server and type.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
modify_server_properties
self.api.modify_server_properties(server_name: str, properties_to_update: Dict[str, str], restart_after_modify: bool = True)
Description: Modifies one or more properties in server.properties.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
prune_download_cache
self.api.prune_download_cache(download_dir: str, keep_count: Optional[int] = None)
Description: Prunes old downloaded server archives (.zip) in a directory.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
prune_old_backups
self.api.prune_old_backups(server_name: str)
Description: Prunes old backups for a server based on retention settings.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
remove_players_from_allowlist
self.api.remove_players_from_allowlist(server_name: str, player_names: List[str])
Description: Removes one or more players from the server’s allowlist by name.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
reset_world
self.api.reset_world(server_name: str)
Description: Resets the server’s world by deleting the active world directory.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
restart_server
self.api.restart_server(server_name: str, 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, 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, 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, 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()
Description: Scans all server logs to discover and save player data.
send_command
self.api.send_command(server_name: str, command: str)
Description: Sends a command to a running Bedrock server.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
set_custom_global_setting
self.api.set_custom_global_setting(key: str, value: Any)
Description: Writes a custom value to the global application settings.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
set_server_custom_value
self.api.set_server_custom_value(server_name: str, key: str, value: Any)
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, mode: str = 'direct')
Description: Starts the specified Bedrock server.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
stop_server
self.api.stop_server(server_name: str)
Description: Stops the specified Bedrock server.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
trigger_external_plugin_event_api
self.api.trigger_external_plugin_event_api(event_name: str, payload: Dict[str, Any] = None)
Description: Allows an external source (like a web route or CLI) to trigger a custom plugin event.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
update_server
self.api.update_server(server_name: str, send_message: bool = True)
Description: Updates an existing server to its configured target version.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|
validate_server_exist
self.api.validate_server_exist(server_name: str)
Description: Validates if a server is correctly installed.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
validate_server_name_format
self.api.validate_server_name_format(server_name: str)
Description: Validates the format of a potential server name.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
validate_server_property_value
self.api.validate_server_property_value(property_name: str, value: str)
Description: Validates a single server property value based on known rules.
Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
|
|
|