Install API Documentation

bedrock_server_manager.api.install.install_new_server(server_name: str, app_context: AppContext, target_version: str = 'LATEST', server_zip_path: str | None = None) → Dict[str, Any]

Installs a new server instance.

Parameters:

  • server_name (str) – The name for the new server.

  • app_context (AppContext) – The application context.

  • target_version (str, optional) – The target version to install (default: “LATEST”).

  • server_zip_path (Optional[str], optional) – Path to a local zip file for installation.

Returns:

A dictionary containing the installation status and message.

Return type:

Dict[str, Any]

bedrock_server_manager.api.install.update_server(server_name: str, app_context: AppContext, send_message: bool = True) → Dict[str, Any]

Updates an existing server instance.

Parameters:

  • server_name (str) – The name of the server to update.

  • app_context (AppContext) – The application context.

  • send_message (bool, optional) – Whether to send a message to players before updating.

Returns:

A dictionary containing the update status, a boolean flag updated, and a message.

Return type:

Dict[str, Any]