API Documentation

The functions listed in this part represent the primary, high-level interface for interacting with the Bedrock Server Manager. These APIs are used by all official components, including the Command-Line Interface (CLI), the Web, and the Plugin system.

These APIs provide a safe, consistent, and stable way to manage servers and the application itself.

Note

For Plugin Developers: The self.api object in your plugin exposes these APIs for your usage. However, to ensure consistency and safety of user data, only a specific subset of these APIs are endorsed for plugin use. Please refer to the Available APIs sections of the Plugins Docs for the full list of functions that are guaranteed to be stable and supported for plugins.

Server Actions

• Server API Documentation
  • get_server_setting()
  • set_server_setting()
  • set_server_custom_value()
  • get_all_server_settings()
  • start_server()
  • stop_server()
  • restart_server()
  • send_command()
  • delete_server_data()

Server Install & Config

• Server Install & Config API Documentation
  • add_players_to_allowlist_api()
  • get_server_allowlist_api()
  • remove_players_from_allowlist()
  • configure_player_permission()
  • get_server_permissions_api()
  • get_server_properties_api()
  • validate_server_property_value()
  • modify_server_properties()
  • install_new_server()
  • update_server()

Backup & Restore

• Backup & Restore API Documentation
  • list_backup_files()
  • backup_world()
  • backup_config_file()
  • backup_all()
  • restore_all()
  • restore_world()
  • restore_config_file()
  • prune_old_backups()

Content Management

• World API Documentation
  • get_world_name()
  • export_world()
  • import_world()
  • reset_world()
• Addon API Documentation
  • import_addon()

Plugin Management

• Plugins API Documentation
  • get_plugin_statuses()
  • set_plugin_status()
  • reload_plugins()
  • trigger_external_plugin_event_api()

Global Operations

• Application API Documentation
  • get_application_info_api()
  • list_available_worlds_api()
  • list_available_addons_api()
  • get_all_servers_data()
• Player API Documentation
  • add_players_manually_api()
  • get_all_known_players_api()
  • scan_and_update_player_db_api()

System Functions

• System API Documentation
  • get_bedrock_process_info()
  • set_autoupdate()
  • set_autostart()

Web Server

• Web API Documentation
  • start_web_server_api()
  • stop_web_server_api()
  • get_web_server_status_api()
  • create_web_ui_service()
  • enable_web_ui_service()
  • disable_web_ui_service()
  • remove_web_ui_service()
  • get_web_ui_service_status()

Miscellaneous

• Misc API Documentation
  • prune_download_cache()
• Info API Documentation
  • get_server_running_status()
  • get_server_config_status()
  • get_server_installed_version()
• Utils API Documentation
  • validate_server_exist()
  • validate_server_name_format()
  • update_server_statuses()
  • get_system_and_app_info()
  • stop_all_servers()
  • server_lifecycle_manager()