Skip to documentation
Bedrock Server Manager Logo

Start here

  • What BSM manages
    • Find the right guide
  • First startup
    • Create your first server
    • Make startup persistent
  • Upgrade an installation
    • Prepare
    • Install and verify
    • Roll back deliberately
  • Install Bedrock Server Manager
    • Install a release
    • Run from source
    • Choose storage
  • Command-line tools
    • Local hosting and administration
    • Remote management
    • Interactive client
  • Use the web interface
    • Manage a server
    • Manage the installation
  • Accounts, roles and access
    • Manage user accounts and per-server access
      • Role and permission reference
    • Your account, MFA, sessions, and integration tokens
      • Passkeys, TOTP MFA, and trusted devices
      • Integration tokens (bsm_it_...)
      • Invitations and password requirements
      • Security audit log
    • Runtime shutdown
    • Grant access deliberately
  • Troubleshooting
    • Startup or connection fails
    • Logs and background tasks
    • Plugin problems
    • Problems after upgrading
    • Diagnostic snapshots
    • Report an issue
    • Missing endpoints or frontend assets

Manage servers

  • Install and update game servers
    • Install a server
    • Update deliberately
    • Automatic startup and updates
  • Manage running servers
    • Start, stop and restart
    • Console commands
    • Online players
      • Ban an online player
    • Monitor, logs, and server removal
  • Configure a Bedrock server
    • Properties
    • Allowlist
    • Player permissions
    • Server bans
    • Known-player directory
  • Back up and restore a server
    • What is included
    • Create and download a backup
    • Encryption and recovery keys
    • Schedule automated backups and verification
    • Back up before starting Minecraft
    • Inspect and restore selected components
      • Full-directory restore
      • Capacity checks and dry runs
      • Restore as a new server
    • Interrupted or failed restores
    • Retention and off-host destinations
      • Local archives
      • External copies
    • Verification, readiness, and recovery drills
    • Recover on a fresh installation
      • Extract without a running manager
      • Export recovery evidence
    • Older backup files
    • Pre-start backup deadlines
    • Compression profiles
    • Safety limits
  • Schedule automated tasks
    • Create and manage schedules
      • CLI schedule management
    • Built-in scheduled tasks
      • Plugin-provided tasks
    • Timezones, daylight saving time, and staggering
      • Staggering across servers
    • Execution controls
    • Missed runs, retries, and concurrency
      • Retries and interactive contention
      • Concurrency and polling settings
  • Worlds and addons
    • Import and export worlds
    • Install and manage addons
    • Choose a subpack
    • Content library management, icons, and archive safety
  • Application settings and storage
    • Bootstrap configuration
    • Stored settings
      • General and scheduler settings
      • Storage paths and retention
      • Monitoring intervals
      • Web and proxy settings
      • Security settings
      • Lifecycle, event bus, and diagnostic settings
      • Custom and plugin settings
    • Directory layout and private credentials
      • Configuration root (<config_dir>)
      • Data root (<data_dir>)
  • Bundled plugins
    • Review automation before maintenance
    • Backup reuse within an operation
    • Bundled plugin settings reference
      • server_lifecycle_notifications
      • world_operation_notifications
      • autostart_plugin, update_before_start, and auto_reload_config

CLI Commands

  • Local CLI Commands
    • bedrock-server-manager
      • backup
        • extract
        • inspect
      • cleanup
      • database
        • backup
        • downgrade
        • restore
        • status
        • upgrade
      • logs
      • reset-mfa
      • reset-password
      • service
        • configure
        • disable
        • enable
        • remove
        • status
      • setup
      • web
        • start
        • stop
  • API Client Commands
    • bsm-cli
      • account
        • change-password
        • details
        • update-profile
        • update-theme
      • addon
        • install
        • manage
      • allowlist
        • add
        • list
        • remove
      • api
        • call
        • diff
        • download
        • export
        • info
        • operation
        • operations
        • refresh
        • schema
      • appearance
        • set
        • show
      • audit
      • auth
        • login
        • logout
        • setup
      • backup
        • create
        • prune
        • restore
      • bans
        • add
        • list
        • remove
      • content
        • upload
      • diagnostics
        • compare
        • history
        • report
        • runs
        • snapshot
        • trace
      • events
        • activity
        • catalog
      • health
      • logs
      • monitor
      • overview
      • permissions
        • list
        • set
      • player
        • add
        • scan
      • plugin
        • call
        • disable
        • enable
        • list
        • operations
        • reload
        • settings
        • trigger-event
      • properties
        • get
        • raw
        • set
      • runtime
      • server
        • delete
        • install
        • list
        • monitor
        • restart
        • send-command
        • settings
        • start
        • stop
        • update
      • settings
      • shutdown
      • tasks
        • list
        • show
      • users
        • delete
        • disable
        • enable
        • invite
        • list
        • set-role
      • world
        • export
        • install
        • reset

Administration and integrations

  • Run BSM in Docker
    • Persist configuration and data
    • Stop, upgrade, and run local recovery commands
  • HTTP API and clients
    • Authenticate
    • Handle responses
    • Upgrade integrations
  • Place content files manually
  • Hosting and web customization
    • Reverse proxies
      • HTTPS and ingress paths
    • Appearance
    • Process ownership
  • Real-time WebSockets and log streaming
    • Connecting and authenticating
    • Available topics
      • Log history over HTTP (GET /api/logs/history)
      • Control frames and connection lifecycle
    • Request / response data providers
      • Task Manager Topics
    • State ordering across HTTP and WebSockets
    • Application performance metrics
  • Web runtime and graceful shutdown
    • HTTP control
    • Local CLI control
    • Service supervision
    • Forced-stop identity
    • Local supervisor readiness
  • Diagnostics and support reports
    • Inspect diagnostics in the web interface
    • Read the diagnostic API
    • What survives restarts
    • Plugin-owned observations
    • Diagnose the diagnostic subsystem
    • Compare snapshots
    • Optional periodic history
    • Global event and operation activity
    • Troubleshooting long operations
  • Theming
    • Appearance settings
    • Built-in themes
    • Creating a personal palette
      • Importing and exporting
    • Installing a shared CSS theme or custom panorama
      • Custom background panorama
    • Writing a CSS theme
    • Theme variables
      • Colors and surfaces
      • Status and chart colors
      • Typography and shape
    • Migrating older themes
    • Plugin theming
    • Troubleshooting

Changelog

  • Changelog
    • 4.0.2
    • 4.0.1
      • What’s Changed
        • 🐛 Bug Fixes
    • 4.0.0
      • Bedrock Server Manager 4.0.0
        • Live world backups and exports
        • A rebuilt asynchronous core
        • Validated state and more reliable persistence
        • Consistent state ordering over HTTP and WebSockets
        • Application Monitor and diagnostics
        • Refreshed web interface and appearance
        • Plugin settings with validation
        • Typed APIs and clearer operation results
        • Application-owned events and plugin resources
        • Graceful shutdown and safer hosting
        • Reverse proxies, HTTPS, and Home Assistant ingress
        • Logging and reliability fixes
        • Breaking changes and compatibility
        • Upgrading from 3.10.6
        • Release links
        • What’s Changed
    • 3.10.6
      • What’s New:
        • Plugin Refactors:
        • What’s Changed
    • 3.10.5
      • What’s New:
    • 3.10.4
      • What’s Changed
        • ⬆️ Dependencies
    • 3.10.3
      • What’s Changed
        • ⬆️ Dependencies
    • 3.10.2
      • What’s Changed
        • ⬆️ Dependencies
      • New Contributors
    • 3.10.1
      • What’s Changed
        • 🚀 Features
    • 3.10.0
      • New Features:
        • What’s Changed
    • 3.9.1
      • What’s Changed
        • 💄 Style & Refactoring
        • ⬆️ Dependencies
    • 3.9.0
      • What’s Changed
        • ⚠️ Breaking Changes
        • 🚀 Features
        • 🐛 Bug Fixes
        • 📚 Documentation
        • 💄 Style & Refactoring
        • ⬆️ Dependencies
        • 🧹 Chore
    • 3.8.0
      • New UI Improvements:
      • What’s Changed
        • ⚠️ Breaking Changes
        • 🚀 Features
        • 🐛 Bug Fixes
        • 📚 Documentation
        • 💄 Style & Refactoring
        • ⚡ Performance
        • 🧪 Tests
        • 📦 Build & CI
        • ⬆️ Dependencies
        • 🧹 Chore
    • 3.7.2
      • What’s Changed
        • 🚀 Features
        • 📚 Documentation
        • 📦 Build & CI
        • 🧹 Chore
    • 3.7.1
      • New Features:
      • Bug Fixes:
    • 3.7.0
      • New Features:
      • Backend Changes:
    • 3.6.3
      • New Features:
      • Backend Changes:
    • 3.6.2
      • Bug Fixes:
    • 3.6.1
      • New Features:
      • Backend Changes:
    • 3.6.0
      • Important Notices & Breaking Changes
      • Core Architectural Changes
      • Database and Configuration Migration
      • Server Management
      • Multi-User and Access Control
      • System Service Improvements
      • Plugin and Developer Updates
      • Other Backend Changes
    • 3.5.7
    • 3.5.6
    • 3.5.5
    • 3.5.4
    • 3.5.3
    • 3.5.2
    • 3.5.1
    • 3.5.0
    • 3.4.1
    • 3.4.0
    • 3.3.1
    • 3.3.0
    • 3.2.5
    • 3.2.4
    • 3.2.3
    • 3.2.2
    • 3.2.1
    • 3.2.0
    • 3.1.4
    • 3.1.3
    • 3.1.2
    • 3.1.1
    • 3.1.0
    • 3.0.3
    • 3.0.2
    • 3.0.1
      • 3.0.1
    • 3.0.0
      • 3.0.0

Use and develop plugins

  • Install and manage plugins
    • Install
    • Configure and reload
    • Repository examples
    • Settings scopes
  • Write a plugin
    • Minimal plugin
      • Discovery and naming rules
    • Standardized decorators and declarative attributes
    • Diagnostic and WebSocket data providers
      • Diagnostic providers (@diagnostic_provider)
      • WebSocket data providers (@data_provider / @websocket_provider)
    • Call typed capabilities
    • Handle events
    • Own and release resources
  • Calling the plugin API
    • Validation and failures
    • Events
    • Runtime capabilities
    • Operation context
      • Additional event capabilities
      • Backups, snapshots, and component settings
  • Available plugin APIs
    • Addon plugin APIs
      • addon.disable_addon
      • addon.enable_addon
      • addon.import_addon
      • addon.list_available_addons
      • addon.list_installed_addons
      • addon.reorder_addons
    • Allowlist plugin APIs
      • allowlist.add_to_allowlist
      • allowlist.get_allowlist
      • allowlist.remove_from_allowlist
    • Application plugin APIs
      • application.get_all_servers_data
      • application.get_system_and_app_info
      • application.list_available_worlds
    • Backup Restore plugin APIs
      • backup_restore.backup_all
      • backup_restore.backup_config_file
      • backup_restore.backup_world
      • backup_restore.can_reuse_server_backup
      • backup_restore.cleanup_backup_destination
      • backup_restore.create_server_backup
      • backup_restore.delete_server_backup
      • backup_restore.download_backup_recovery_report
      • backup_restore.dry_run_server_restore
      • backup_restore.get_backup_health
      • backup_restore.get_restore_recovery
      • backup_restore.inspect_server_backup
      • backup_restore.list_backup_files
      • backup_restore.list_server_snapshots
      • backup_restore.manage_server_snapshot
      • backup_restore.plan_server_restore
      • backup_restore.prepare_backup_copy
      • backup_restore.prune_old_backups
      • backup_restore.recover_server_backup
      • backup_restore.restore_all
      • backup_restore.restore_config_file
      • backup_restore.restore_server_snapshot
      • backup_restore.restore_world
    • Ban plugin APIs
      • ban.add_server_ban
      • ban.get_server_bans
      • ban.remove_server_ban
    • Diagnostics plugin APIs
      • diagnostics.compare_diagnostic_snapshots
      • diagnostics.get_application_diagnostics
      • diagnostics.get_diagnostic_activity
      • diagnostics.get_diagnostic_history
      • diagnostics.get_diagnostic_report
      • diagnostics.get_diagnostic_runs
      • diagnostics.get_diagnostic_trace
    • Install plugin APIs
      • install.install_new_server
      • install.update_server
    • Misc plugin APIs
      • misc.prune_download_cache
    • Permissions plugin APIs
      • permissions.get_permissions
      • permissions.set_permissions
    • Player plugin APIs
      • player.add_players_manually
      • player.get_all_known_players
      • player.scan_and_update_player_db
    • Plugins plugin APIs
      • plugins.get_plugin_setting
      • plugins.get_plugin_statuses
      • plugins.set_plugin_setting
    • Properties plugin APIs
      • properties.get_properties
      • properties.get_raw_properties
      • properties.set_properties
      • properties.validate_property_value
    • Scheduler plugin APIs
      • scheduler.list_schedules
    • Server plugin APIs
      • server.get_all_settings
      • server.get_setting
      • server.get_summary
      • server.get_valid_names
      • server.restart
      • server.send_command
      • server.set_custom_value
      • server.start
      • server.stop
    • Settings plugin APIs
      • settings.get_all_global_settings
      • settings.get_global_setting
      • settings.set_custom_global_setting
    • System plugin APIs
      • system.get_application_health
      • system.get_application_metrics
      • system.get_bedrock_process_info
      • system.get_server_running_status
    • Websocket plugin APIs
      • websocket.websocket_broadcast
      • websocket.websocket_publish_ws_event
      • websocket.websocket_send_to_client
      • websocket.websocket_send_to_user
      • websocket.websocket_unregister_data_provider
    • World plugin APIs
      • world.export_world
      • world.get_world_name
      • world.import_world
      • world.reset_world
    • Plugin contract models
      • APIErrorResponse
      • AddPlayersManuallyRequest
      • AddPlayersManuallyResponse
      • AddServerBanRequest
      • AddServerBanResponse
      • AddToAllowlistRequest
      • AddToAllowlistResponse
      • AllowlistPlayer
      • AllowlistRemovalDetails
      • BackupAllRequest
      • BackupAllResponse
      • BackupConfigFileRequest
      • BackupConfigFileResponse
      • BackupCopy
      • BackupFile
      • BackupHealth
      • BackupHealthResponse
      • BackupManifest
      • BackupSummary
      • BackupVerification
      • BackupWorldRequest
      • BackupWorldResponse
      • BackupsDiagnostics
      • BanInfo
      • BroadcastRequest
      • BroadcastResponse
      • CleanupBackupDestinationRequest
      • CleanupBackupDestinationResponse
      • CleanupResult
      • CollectionDiagnostics
      • CompareDiagnosticSnapshotsRequest
      • CompareDiagnosticSnapshotsResponse
      • CompletedItem
      • ComponentResults
      • CreateSnapshotRequest
      • CreateSnapshotResponse
      • DeleteSnapshotRequest
      • DeliveryResult
      • DestinationCleanupPlan
      • DiagnosticChange
      • DiagnosticEnvironment
      • DiagnosticFinding
      • DiagnosticHealthSample
      • DiagnosticHistory
      • DiagnosticIssue
      • DiagnosticRecord
      • DiagnosticRun
      • DiagnosticRuns
      • DiagnosticSection
      • DiagnosticSnapshot
      • DiagnosticSummary
      • DisableAddonRequest
      • DisableAddonResponse
      • EnableAddonRequest
      • EnableAddonResponse
      • EventDelivery
      • EventDiagnostics
      • EventFilter
      • EventOptions
      • EventRecord
      • EventSubscriptionInfo
      • EventSubscriptions
      • EventsDiagnostics
      • ExportWorldRequest
      • ExportWorldResponse
      • FailedItem
      • FailureInfo
      • GetAllGlobalSettingsRequest
      • GetAllGlobalSettingsResponse
      • GetAllKnownPlayersRequest
      • GetAllKnownPlayersResponse
      • GetAllServerSettingsRequest
      • GetAllServerSettingsResponse
      • GetAllServersDataRequest
      • GetAllServersDataResponse
      • GetAllowlistRequest
      • GetAllowlistResponse
      • GetApplicationDiagnosticsRequest
      • GetApplicationDiagnosticsResponse
      • GetApplicationHealthRequest
      • GetApplicationHealthResponse
      • GetApplicationMetricsRequest
      • GetApplicationMetricsResponse
      • GetBedrockProcessInfoRequest
      • GetBedrockProcessInfoResponse
      • GetDiagnosticActivityRequest
      • GetDiagnosticActivityResponse
      • GetDiagnosticHistoryRequest
      • GetDiagnosticHistoryResponse
      • GetDiagnosticReportRequest
      • GetDiagnosticReportResponse
      • GetDiagnosticRunsRequest
      • GetDiagnosticRunsResponse
      • GetDiagnosticTraceRequest
      • GetDiagnosticTraceResponse
      • GetGlobalSettingRequest
      • GetGlobalSettingResponse
      • GetPermissionsRequest
      • GetPermissionsResponse
      • GetPluginSettingRequest
      • GetPluginSettingResponse
      • GetPluginStatusesRequest
      • GetPluginStatusesResponse
      • GetPropertiesRequest
      • GetPropertiesResponse
      • GetRawPropertiesRequest
      • GetRawPropertiesResponse
      • GetServerBansRequest
      • GetServerBansResponse
      • GetServerRunningStatusRequest
      • GetServerRunningStatusResponse
      • GetServerSettingRequest
      • GetServerSettingResponse
      • GetServerSummaryRequest
      • GetServerSummaryResponse
      • GetSystemAndAppInfoRequest
      • GetSystemAndAppInfoResponse
      • GetValidServerNamesRequest
      • GetValidServerNamesResponse
      • GetWorldNameRequest
      • GetWorldNameResponse
      • HealthCheck
      • ImportAddonRequest
      • ImportAddonResponse
      • ImportWorldRequest
      • ImportWorldResponse
      • InspectSnapshotRequest
      • InspectSnapshotResponse
      • InstallNewServerRequest
      • InstallNewServerResponse
      • InstalledAddon
      • InstalledAddons
      • JsonValue
      • LifecyclePhase
      • ListAvailableAddonsRequest
      • ListAvailableAddonsResponse
      • ListAvailableWorldsRequest
      • ListAvailableWorldsResponse
      • ListBackupFilesRequest
      • ListBackupFilesResponse
      • ListInstalledAddonsRequest
      • ListInstalledAddonsResponse
      • ListSchedulesRequest
      • ListSchedulesResponse
      • ListSnapshotsRequest
      • ListSnapshotsResponse
      • ListenerFailure
      • ListenerRecord
      • ManageSnapshotRequest
      • ManageSnapshotResponse
      • MetricsDiagnostics
      • MetricsSample
      • OperationActivity
      • OperationSnapshot
      • PersistenceDiagnostics
      • PlanSnapshotRestoreRequest
      • PlanSnapshotRestoreResponse
      • PlayerInfo
      • PlayerPermission
      • PlayerScanDetails
      • PlayerScanError
      • PluginDiagnostic
      • PluginInfo
      • PluginValues
      • PluginsDiagnostics
      • PrepareBackupCopyRequest
      • PrepareBackupCopyResponse
      • ProcessDiagnostic
      • ProcessInfo
      • ProcessesDiagnostics
      • PruneDownloadCacheRequest
      • PruneDownloadCacheResponse
      • PruneOldBackupsRequest
      • PruneOldBackupsResponse
      • PublishWsEventRequest
      • PublishWsEventResponse
      • RecentDiagnosticCounts
      • RecentDiagnosticWindow
      • RecoveryReport
      • RecoveryReportArchive
      • RecoveryReportDrill
      • RecoveryReportOutcome
      • RecoveryReportResponse
      • RecoveryReportReview
      • RegistryDiagnostics
      • RemoveFromAllowlistRequest
      • RemoveFromAllowlistResponse
      • RemoveServerBanRequest
      • RemoveServerBanResponse
      • ReorderAddonsRequest
      • ReorderAddonsResponse
      • ResetWorldRequest
      • ResetWorldResponse
      • ResourceFailure
      • RestartServerRequest
      • RestartServerResponse
      • RestoreAllRequest
      • RestoreAllResponse
      • RestoreConfigFileRequest
      • RestoreConfigFileResponse
      • RestoreFileChange
      • RestorePlan
      • RestoreRecoveryResponse
      • RestoreRecoveryState
      • RestoreResult
      • RestoreSnapshotRequest
      • RestoreSnapshotResponse
      • RestoreValueChange
      • RestoreVolume
      • RestoreWorldRequest
      • RestoreWorldResponse
      • RuntimeDiagnostics
      • ScanAndUpdatePlayerDbRequest
      • ScanAndUpdatePlayerDbResponse
      • ScheduleConfigurationView
      • ScheduleEntry
      • SendCommandRequest
      • SendCommandResponse
      • SendToClientRequest
      • SendToClientResponse
      • SendToUserRequest
      • SendToUserResponse
      • ServerMetrics
      • ServerSummary
      • SetCustomGlobalSettingRequest
      • SetCustomGlobalSettingResponse
      • SetPermissionsRequest
      • SetPermissionsResponse
      • SetPluginSettingRequest
      • SetPluginSettingResponse
      • SetPropertiesRequest
      • SetPropertiesResponse
      • SetServerCustomValueRequest
      • SetServerCustomValueResponse
      • SkippedItem
      • SnapshotReuseRequest
      • SnapshotReuseResponse
      • StartServerRequest
      • StartServerResponse
      • StateDiagnostics
      • StopServerRequest
      • StopServerResponse
      • StorageDiagnostics
      • Subpack
      • TaskDiagnostic
      • TasksDiagnostics
      • TransportDiagnostics
      • UnregisterDataProviderRequest
      • UnregisterDataProviderResponse
      • UpdateServerRequest
      • UpdateServerResponse
      • ValidatePropertyValueRequest
      • ValidatePropertyValueResponse
  • Available plugin events
    • after_add_server_ban
      • Listener Signature:
      • Available kwargs:
    • after_addon_disable
      • Listener Signature:
      • Available kwargs:
    • after_addon_enable
      • Listener Signature:
      • Available kwargs:
    • after_addon_import
      • Listener Signature:
      • Available kwargs:
    • after_addon_reorder
      • Listener Signature:
      • Available kwargs:
    • after_addon_subpack_update
      • Listener Signature:
      • Available kwargs:
    • after_addon_uninstall
      • Listener Signature:
      • Available kwargs:
    • after_allowlist_change
      • Listener Signature:
      • Available kwargs:
    • after_backup
      • Listener Signature:
      • Available kwargs:
    • after_command_send
      • Listener Signature:
      • Available kwargs:
    • after_delete_server_data
      • Listener Signature:
      • Available kwargs:
    • after_permission_change
      • Listener Signature:
      • Available kwargs:
    • after_player_db_scan
      • Listener Signature:
      • Available kwargs:
    • after_players_add
      • Listener Signature:
      • Available kwargs:
    • after_plugin_settings_update
      • Listener Signature:
      • Available kwargs:
    • after_properties_change
      • Listener Signature:
      • Available kwargs:
    • after_prune_backups
      • Listener Signature:
      • Available kwargs:
    • after_prune_download_cache
      • Listener Signature:
      • Available kwargs:
    • after_remove_server_ban
      • Listener Signature:
      • Available kwargs:
    • after_restore
      • Listener Signature:
      • Available kwargs:
    • after_server_install
      • Listener Signature:
      • Available kwargs:
    • after_server_players_change
      • Listener Signature:
      • Available kwargs:
    • after_server_start
      • Listener Signature:
      • Available kwargs:
    • after_server_status_change
      • Listener Signature:
      • Available kwargs:
    • after_server_stop
      • Listener Signature:
      • Available kwargs:
    • after_server_update
      • Listener Signature:
      • Available kwargs:
    • after_set_plugin_status
      • Listener Signature:
      • Available kwargs:
    • after_set_server_setting
      • Listener Signature:
      • Available kwargs:
    • after_setting_update
      • Listener Signature:
      • Available kwargs:
    • after_world_export
      • Listener Signature:
      • Available kwargs:
    • after_world_import
      • Listener Signature:
      • Available kwargs:
    • after_world_reset
      • Listener Signature:
      • Available kwargs:
    • backup_activity
      • Listener Signature:
      • Available kwargs:
    • backup_attention
      • Listener Signature:
      • Available kwargs:
    • before_add_server_ban
      • Listener Signature:
      • Available kwargs:
    • before_addon_disable
      • Listener Signature:
      • Available kwargs:
    • before_addon_enable
      • Listener Signature:
      • Available kwargs:
    • before_addon_import
      • Listener Signature:
      • Available kwargs:
    • before_addon_reorder
      • Listener Signature:
      • Available kwargs:
    • before_addon_subpack_update
      • Listener Signature:
      • Available kwargs:
    • before_addon_uninstall
      • Listener Signature:
      • Available kwargs:
    • before_allowlist_change
      • Listener Signature:
      • Available kwargs:
    • before_backup
      • Listener Signature:
      • Available kwargs:
    • before_command_send
      • Listener Signature:
      • Available kwargs:
    • before_delete_server_data
      • Listener Signature:
      • Available kwargs:
    • before_permission_change
      • Listener Signature:
      • Available kwargs:
    • before_player_db_scan
      • Listener Signature:
      • Available kwargs:
    • before_players_add
      • Listener Signature:
      • Available kwargs:
    • before_properties_change
      • Listener Signature:
      • Available kwargs:
    • before_prune_backups
      • Listener Signature:
      • Available kwargs:
    • before_prune_download_cache
      • Listener Signature:
      • Available kwargs:
    • before_remove_server_ban
      • Listener Signature:
      • Available kwargs:
    • before_restore
      • Listener Signature:
      • Available kwargs:
    • before_server_install
      • Listener Signature:
      • Available kwargs:
    • before_server_players_change
      • Listener Signature:
      • Available kwargs:
    • before_server_start
      • Listener Signature:
      • Available kwargs:
    • before_server_status_change
      • Listener Signature:
      • Available kwargs:
    • before_server_stop
      • Listener Signature:
      • Available kwargs:
    • before_server_update
      • Listener Signature:
      • Available kwargs:
    • before_set_plugin_status
      • Listener Signature:
      • Available kwargs:
    • before_set_server_setting
      • Listener Signature:
      • Available kwargs:
    • before_setting_update
      • Listener Signature:
      • Available kwargs:
    • before_world_export
      • Listener Signature:
      • Available kwargs:
    • before_world_import
      • Listener Signature:
      • Available kwargs:
    • before_world_reset
      • Listener Signature:
      • Available kwargs:
    • on_account_security
      • Listener Signature:
    • on_load
      • Listener Signature:
    • on_manager_startup
      • Listener Signature:
    • on_unload
      • Listener Signature:
  • Plugin Base
    • PluginBase
      • PluginBase.settings_model
      • PluginBase.global_settings_model
      • PluginBase.server_settings_model
      • PluginBase.author
      • PluginBase.description
      • PluginBase.dependencies
      • PluginBase.optional_dependencies
      • PluginBase.router
      • PluginBase.routers
      • PluginBase.static_mounts
      • PluginBase.http_permissions
      • PluginBase.scheduled_apis
      • PluginBase.name
      • PluginBase.get_plugin_setting()
      • PluginBase.set_plugin_setting()
      • PluginBase.get_plugin_settings()
      • PluginBase.set_plugin_settings()
      • PluginBase.get_fastapi_routers()
      • PluginBase.get_static_mounts()
  • Plugin Manager
    • PluginManager
      • PluginManager.quiesce()
      • PluginManager.has_pending_lifespans
      • PluginManager.shutdown()
      • PluginManager.get_native_ui_routes()
      • PluginManager.register_app_event_listener()
      • PluginManager.dispatch_event()
      • PluginManager.trigger_event()
      • PluginManager.trigger_guarded_event()
      • PluginManager.start_plugin_tasks()
      • PluginManager.load_plugins()
      • PluginManager.unload_plugins()
      • PluginManager.reload()
      • PluginManager.bind_web_app()
      • PluginManager.diagnostic_snapshot()
      • PluginManager.get_plugin_runtime()
      • PluginManager.get_plugin_status()
      • PluginManager.unload_plugin_by_name()
      • PluginManager.load_plugin_by_name()
      • PluginManager.reload_plugin()
      • PluginManager.enable_plugin()
      • PluginManager.disable_plugin()
  • Custom events and cancellation
    • Cancelling an operation
    • Application event subsystem
    • Declaring and emitting a typed event
    • Diagnostics and limits
    • Filtered activity
    • One-shot listeners and event waits
    • Opt-in typed hooks and observers
    • Discovering contracts and inspecting subscriptions
    • Filtering and ordering listeners
    • Temporary event subscriptions
    • Plugin-owned operation scopes
    • Observe events across all execution chains
  • Plugin Settings and Storage
    • Managing Configuration
      • 1. Isolated Plugin Settings
      • 2. Custom Global Application Settings
      • 3. Server-Specific Custom Settings
    • Typed settings and the web editor
      • Server references
    • Plugin-owned configuration and data files
      • Storage scopes and directory roots
      • Supported file formats (format)
      • Path validation, atomic writes, and restricted directories
    • Global and server settings models
  • Scheduled tasks in plugins
    • Choose the right execution model
    • Declare custom scheduled tasks with @scheduled_task
      • Automatic inference and naming
      • Options validation and UI schema generation
    • Expose existing APIs with scheduled_apis
      • How register_api_task wraps an API method
    • Execution context, locking, and timeouts
      • Execution context and idempotency
      • Server locks and cooperative deferral
      • Timeouts and cancellation
      • Plugin lifecycle and availability
    • Inspect schedules from a plugin
  • Custom FastAPI endpoints
    • Static asset mounts (static_mounts)
    • Router resources
  • Native JSON UI for Plugins
    • How it Works
      • Global Server Context
      • Basic Example
    • Available Components
      • Layout
      • Typography
      • Basic Inputs
      • Display & Media
      • Interactive
      • Data & Monitoring
    • Actions
      • API Call
      • Navigate
      • Modal Control
    • Real-time Updates (WebSockets)
    • Icons
    • Comprehensive Examples
      • Form and API Submission
      • Table View
      • Real-Time Monitoring Dashboard
  • Background tasks
    • Submitting a task
    • Tracking a task
    • Reporting progress
    • Using @task_loop for Periodic Tasks

Backend contributors and Python reference

  • Backend architecture and documentation
    • Choose a boundary
    • Maintain documentation
  • Contributor setup and validation
    • Checks
  • Event architecture
    • Dispatch and failure ownership
    • Extending and testing
    • Operation sequences
  • State, storage and service mutations
    • Mutation boundaries
    • Database evolution
  • Diagnostics and health architecture
    • Collection contracts
    • Persistence and privacy
  • Runtime ownership and cleanup
    • Lifespan and shutdown
    • Embedding and tests
  • Adding an API contract
    • Requests, results and errors
    • HTTP and consumer changes
  • Web composition and package boundaries
  • HTTP permissions and browser authentication
    • Credential precedence and cookies
    • Swagger
    • Plugins
    • Logout
    • Account security
    • Named integration credentials
    • Assigned servers
    • Changes, tasks, and sockets
    • Authentication hardening
      • Registration invitation storage and concurrency
    • Authentication maintenance and request ownership
      • Reproducible workload measurements
    • Trusted clients and browser response policy
    • Authorization ordering and bounded audit history
    • Remembered second-factor devices
    • Access previews, retention, and execution boundaries
    • Auth audit follow-ups: management and verification
    • Router audit follow-up, passkeys, and host credentials
      • WebAuthn passkeys
      • Passkey proof and concurrency guarantees
  • API Documentation
    • Scheduler API
      • list_schedules()
      • save_schedule()
      • delete_schedule()
      • control_schedule()
    • Server API Documentation
      • get_server_setting()
      • set_server_setting()
      • set_server_custom_value()
      • get_all_server_settings()
      • get_server_summary()
      • start_server()
      • stop_server()
      • restart_server()
      • send_command()
      • delete_server_data()
      • set_server_status()
      • update_server_player_stats()
      • get_valid_server_names()
      • server_lifecycle_manager()
    • Allowlist API Documentation
      • add_to_allowlist()
      • get_allowlist()
      • remove_from_allowlist()
    • Ban API Documentation
      • add_server_ban()
      • remove_server_ban()
      • get_server_bans()
    • Install API Documentation
      • install_new_server()
      • update_server()
    • Permissions API Documentation
      • set_permissions()
      • get_permissions()
    • Properties API Documentation
      • get_properties()
      • get_raw_properties()
      • validate_property_value()
      • set_properties()
    • Settings API Documentation
      • get_global_setting()
      • get_all_global_settings()
      • set_global_setting()
      • set_custom_global_setting()
      • reload_global_settings()
    • Backup & Restore API Documentation
      • list_backup_files()
      • backup_world()
      • backup_config_file()
      • backup_all()
      • restore_all()
      • restore_world()
      • restore_config_file()
      • prune_old_backups()
      • create_server_backup()
      • list_server_snapshots()
      • inspect_server_backup()
      • plan_server_restore()
      • restore_server_snapshot()
      • get_restore_recovery()
      • recover_server_backup()
      • get_backup_health()
      • delete_server_backup()
      • manage_server_snapshot()
      • prepare_backup_copy()
      • can_reuse_server_backup()
      • dry_run_server_restore()
      • cleanup_backup_destination()
      • download_backup_recovery_report()
    • World API Documentation
      • get_world_name()
      • export_world()
      • import_world()
      • reset_world()
    • Addon API Documentation
      • list_available_addons()
      • import_addon()
      • list_installed_addons()
      • enable_addon()
      • disable_addon()
      • update_subpack()
      • uninstall_addon()
      • reorder_addons()
    • Plugins API Documentation
      • get_plugin_statuses()
      • set_plugin_status()
      • reload_single_plugin()
      • reload_plugins()
      • trigger_external_app_event()
      • get_plugin_setting()
      • set_plugin_setting()
      • get_plugin_settings()
      • update_plugin_settings()
    • Application API Documentation
      • list_available_worlds()
      • get_all_servers_data()
      • get_system_and_app_info()
      • update_server_statuses()
    • Diagnostics API
      • get_application_diagnostics()
      • get_diagnostic_history()
      • get_diagnostic_report()
      • get_diagnostic_runs()
      • get_diagnostic_trace()
      • compare_diagnostic_snapshots()
      • get_diagnostic_activity()
    • Player API Documentation
      • add_players_manually()
      • get_all_known_players()
      • scan_and_update_player_db()
    • System API Documentation
      • get_server_running_status()
      • get_bedrock_process_info()
      • get_application_metrics()
      • get_application_health()
    • Web API Documentation
      • create_web_ui_service()
      • enable_web_ui_service()
      • disable_web_ui_service()
      • remove_web_ui_service()
      • get_web_ui_service_status()
    • WebSocket API Documentation
      • broadcast()
      • send_to_user()
      • send_to_client()
      • unregister_data_provider()
      • publish_ws_event()
    • Misc API Documentation
      • prune_download_cache()
    • Result and failure contracts
    • Configuration and recovery failures
  • Core Class Documentation
    • App Context
      • AppContext
        • AppContext.__init__()
        • AppContext.load()
        • AppContext.reload()
        • AppContext.flush()
        • AppContext.startup()
        • AppContext.shutdown()
        • AppContext.pre_app_config
        • AppContext.get_pre_app_config()
        • AppContext.config_dir
        • AppContext.data_dir
        • AppContext.db_url
        • AppContext.log_level
        • AppContext.log_dir
        • AppContext.check_setup()
        • AppContext.needs_setup
        • AppContext.api
        • AppContext.db
        • AppContext.state
        • AppContext.diagnostics
        • AppContext.is_ready
        • AppContext.state_loaded
        • AppContext.storage
        • AppContext.settings
        • AppContext.operations
        • AppContext.events
        • AppContext.plugin_manager
        • AppContext.task_manager
        • AppContext.connection_manager
        • AppContext.metrics_service
        • AppContext.resource_monitor
        • AppContext.log_streamer
        • AppContext.settings_service
        • AppContext.server_service
        • AppContext.plugin_service
        • AppContext.trusted_device_service
        • AppContext.session_service
        • AppContext.access_service
        • AppContext.user_service
        • AppContext.bedrock_process_manager
        • AppContext.get_server()
        • AppContext.get_valid_server_names()
        • AppContext.prepare_server()
        • AppContext.remove_server()
    • Task Manager
      • TaskManager
        • TaskManager.__init__()
        • TaskManager.active_task_count
        • TaskManager.tasks
        • TaskManager.task_access()
        • TaskManager.run_task()
        • TaskManager.report_stage()
        • TaskManager.report_plugin_stage()
        • TaskManager.report_progress()
        • TaskManager.diagnostic_snapshot()
        • TaskManager.cancel_task()
        • TaskManager.get_task()
        • TaskManager.get_all_tasks()
        • TaskManager.allow_plugin()
        • TaskManager.drain_plugin()
        • TaskManager.begin_shutdown()
        • TaskManager.shutdown()
    • Connection Manager
      • ConnectionManager
        • ConnectionManager.__init__()
        • ConnectionManager.connect()
        • ConnectionManager.disconnect()
        • ConnectionManager.revoke_user()
        • ConnectionManager.refresh_authorization()
        • ConnectionManager.can_access_topic()
        • ConnectionManager.authorize_frame()
        • ConnectionManager.subscribe()
        • ConnectionManager.unsubscribe()
        • ConnectionManager.shutdown()
        • ConnectionManager.register_data_provider()
        • ConnectionManager.unregister_data_provider()
        • ConnectionManager.unregister_plugin_providers()
        • ConnectionManager.get_data_provider()
        • ConnectionManager.publish_ws_event()
        • ConnectionManager.diagnostic_snapshot()
        • ConnectionManager.send_to_client()
        • ConnectionManager.broadcast_to_topic()
        • ConnectionManager.send_to_user()
    • Database
      • Database
        • Database.__init__()
        • Database.check_health()
        • Database.initialize()
        • Database.upgrade_schema()
        • Database.downgrade_schema()
        • Database.session_manager()
        • Database.close()
        • Database.shutdown()
    • Settings Core Documentation
      • Settings
        • Settings.__init__()
        • Settings.state
        • Settings.storage
        • Settings.default_config
        • Settings.get()
        • Settings.load()
        • Settings.set()
        • Settings.reload()
    • Bedrock Server Core
      • BedrockServer
        • BedrockServer.get_status()
        • BedrockServer.reconcile_status()
        • BedrockServer.set_status_in_config()
      • Backup and restore
        • ServerBackups
      • Software operations
        • install_or_update()
        • is_update_needed()
        • delete_all_data()
        • set_filesystem_permissions()
    • Bedrock Downloader Core Documentation
      • BedrockDownloader
        • BedrockDownloader.__init__()
        • BedrockDownloader.PRESERVED_ITEMS_ON_UPDATE
        • BedrockDownloader.server_zip_path
        • BedrockDownloader.get_actual_version()
        • BedrockDownloader.get_zip_file_path()
        • BedrockDownloader.get_specific_download_dir()
        • BedrockDownloader.get_resolved_download_url()
        • BedrockDownloader.extract_server_files()
        • BedrockDownloader.full_server_setup()
        • BedrockDownloader.get_version_for_target_spec()
        • BedrockDownloader.prepare_download_assets()
    • Bedrock Process Manager Core Documentation
      • BedrockProcessManager
        • BedrockProcessManager.__init__()
        • BedrockProcessManager.start()
        • BedrockProcessManager.add_server()
        • BedrockProcessManager.remove_server()
        • BedrockProcessManager.quiesce()
        • BedrockProcessManager.shutdown()
        • BedrockProcessManager.write_error_status()
    • Resource Monitor Core Documentation
      • ProcessResourceMonitor
        • ProcessResourceMonitor.__init__()
        • ProcessResourceMonitor.get_stats()
  • Core Documentation
    • Error Class Documentation
      • BSMError
      • APICancelledError
      • FileError
      • ServerError
      • ConfigurationError
      • StorageError
      • SystemError
      • NetworkError
      • UserInputError
      • ResourceNotFoundError
      • OperationConflictError
      • DependencyUnavailableError
      • AppFileNotFoundError
      • FileOperationError
      • DownloadError
      • ExtractError
      • BackupRestoreError
      • IncompleteOperationError
      • ServerProcessError
      • ServerStartError
      • ServerStopError
      • ServerNotRunningError
      • ServerRunningError
      • SendCommandError
      • ConfigParseError
      • BlockedCommandError
      • PermissionsError
      • CommandNotFoundError
      • InternetConnectivityError
      • MissingArgumentError
      • InvalidServerNameError
      • APIResponseValidationError
    • System Base Core Documentation
      • can_manage_services()
      • check_internet_connectivity()
      • delete_path_robustly()
      • find_files()
      • is_server_running()
      • set_server_folder_permissions()
    • System Process Core Documentation
      • GuardedProcess
        • GuardedProcess.create_subprocess_exec()
        • GuardedProcess.create_subprocess_shell()
        • GuardedProcess.popen()
        • GuardedProcess.run()
      • get_bedrock_server_pid_file_path()
      • get_pid_file_path()
      • get_verified_bedrock_process()
      • is_process_running()
      • read_pid_from_file()
      • remove_pid_file_if_exists()
      • verify_process_identity()
      • write_pid_to_file()
    • Core Data Documentation
      • PlayerRecord
        • PlayerRecord.model_config
      • SummaryRecord
        • SummaryRecord.model_config
      • ProcessRecord
        • ProcessRecord.model_config
      • ExternalRecord
        • ExternalRecord.model_config
      • AllowlistEntry
        • AllowlistEntry.model_config
      • PermissionEntry
        • PermissionEntry.model_config
      • ManifestHeader
        • ManifestHeader.model_config
      • ManifestModule
        • ManifestModule.model_config
      • SubpackRecord
        • SubpackRecord.normalize_memory_tier()
        • SubpackRecord.model_config
      • ManifestRecord
        • ManifestRecord.model_config
    • Core Files Documentation
      • atomic_stream_file()
      • validate_archive()
      • FileTransaction
    • Core Manifests Documentation
      • PackManifest
        • PackManifest.model_config
    • Core Player Documentation
      • parse_player_string()
      • discover_and_store_players()
    • Core Service Documentation
      • create_web_service_file()
      • check_web_service_exists()
      • enable_web_service()
      • disable_web_service()
      • remove_web_service_file()
      • is_web_service_active()
      • is_web_service_enabled()
    • Miscellaneous Core Documentation
      • prune_old_downloads()
      • Logging
    • Platform Dependent Core Documentation
      • System Linux Core Documentation
        • check_service_exists()
        • create_systemd_service_file()
        • disable_systemd_service()
        • enable_systemd_service()
        • get_systemd_service_file_path()
      • System Windows Core Documentation
        • check_service_exists()
        • create_windows_service()
        • delete_windows_service()
        • disable_windows_service()
        • enable_windows_service()

Subsystem references

  • Events
    • backup
      • BackupActivity
        • BackupActivity.model_config
      • BackupAttention
        • BackupAttention.model_config
    • bus
      • current_correlation_id()
      • Subscription
      • CallbackState
        • CallbackState.clock()
      • EventWorkerCapacityError
      • EventDispatchRejected
    • capabilities
    • context
      • freeze()
      • EventPayload
        • EventPayload.model_config
      • EventNotification
      • PluginEvent
        • PluginEvent.cancel()
    • control
    • decorator
    • models
      • EventModel
        • EventModel.model_config
      • EventDefinition
        • EventDefinition.model_config
      • EventFilter
        • EventFilter.model_config
      • EventSubscriptionInfo
        • EventSubscriptionInfo.model_config
      • EventSubscriptions
        • EventSubscriptions.model_config
      • EventContext
        • EventContext.model_config
      • EventEnvelope
        • EventEnvelope.model_config
      • ListenerFailure
        • ListenerFailure.model_config
      • EventDelivery
        • EventDelivery.model_config
      • ListenerRecord
        • ListenerRecord.model_config
      • EventRecord
        • EventRecord.model_config
      • EventDiagnostics
        • EventDiagnostics.model_config
      • EventCatalog
        • EventCatalog.model_config
      • EventOptions
        • EventOptions.model_config
      • EventActivityQuery
        • EventActivityQuery.model_config
    • operations
      • OperationName
      • OperationSnapshot
        • OperationSnapshot.model_config
      • OperationResultQuery
        • OperationResultQuery.model_config
      • OperationActivityQuery
        • OperationActivityQuery.model_config
      • OperationActivity
        • OperationActivity.model_config
      • OperationSequence
        • OperationSequence.model_config
      • OperationHandle
      • detached_operations()
      • OperationService
        • OperationService.activity()
      • track_operation()
    • player
      • PlayerPresence
        • PlayerPresence.model_config
      • PlayerSnapshot
        • PlayerSnapshot.model_config
      • PlayerChangeResult
        • PlayerChangeResult.model_config
      • BeforePlayerChange
        • BeforePlayerChange.model_config
      • AfterPlayerChange
        • AfterPlayerChange.model_config
      • publish_player_snapshot()
      • model
    • publisher
      • EventPublisher
    • registry
    • serialization
    • server
      • StatusRequest
        • StatusRequest.model_config
      • StatusResult
        • StatusResult.model_config
      • BeforeStatusChange
        • BeforeStatusChange.model_config
      • AfterStatusChange
        • AfterStatusChange.model_config
      • model
    • websocket
      • TopicPublisher
  • Diagnostics and health
    • activity
      • bound_event_activity()
      • bound_operations()
      • bound_subscriptions()
      • RecentOutcomes
    • comparison
      • compare_snapshots()
    • composition
      • configure_diagnostics()
    • health
      • evaluate_health()
      • summarize_health()
    • history
      • retryable_write()
      • HistoryCursor
        • HistoryCursor.model_config
    • models
      • DiagnosticModel
        • DiagnosticModel.model_config
      • DiagnosticOptions
        • DiagnosticOptions.model_config
      • DiagnosticHealthSample
        • DiagnosticHealthSample.model_config
      • DiagnosticRecord
        • DiagnosticRecord.model_config
      • DiagnosticIssue
        • DiagnosticIssue.model_config
      • RuntimeDiagnostics
        • RuntimeDiagnostics.model_config
      • StateDiagnostics
        • StateDiagnostics.model_config
      • StorageDiagnostics
        • StorageDiagnostics.model_config
      • EventsDiagnostics
        • EventsDiagnostics.model_config
      • TransportDiagnostics
        • TransportDiagnostics.model_config
      • PluginDiagnostic
        • PluginDiagnostic.model_config
      • PluginsDiagnostics
        • PluginsDiagnostics.model_config
      • TaskDiagnostic
        • TaskDiagnostic.model_config
      • TasksDiagnostics
        • TasksDiagnostics.model_config
      • ProcessDiagnostic
        • ProcessDiagnostic.model_config
      • ProcessesDiagnostics
        • ProcessesDiagnostics.model_config
      • MetricsDiagnostics
        • MetricsDiagnostics.model_config
      • BackupsDiagnostics
        • BackupsDiagnostics.model_config
      • SchedulerDiagnostics
        • SchedulerDiagnostics.model_config
      • PluginValues
        • PluginValues.model_config
      • DiagnosticSection
        • DiagnosticSection.model_config
      • PersistenceDiagnostics
        • PersistenceDiagnostics.model_config
      • RegistryDiagnostics
        • RegistryDiagnostics.model_config
      • DiagnosticFinding
        • DiagnosticFinding.model_config
      • DiagnosticSummary
        • DiagnosticSummary.model_config
      • DiagnosticEnvironment
        • DiagnosticEnvironment.model_config
      • CollectionDiagnostics
        • CollectionDiagnostics.model_config
      • RecentDiagnosticCounts
        • RecentDiagnosticCounts.model_config
      • RecentDiagnosticWindow
        • RecentDiagnosticWindow.model_config
      • DiagnosticSnapshot
        • DiagnosticSnapshot.model_config
      • DiagnosticHistory
        • DiagnosticHistory.model_config
      • DiagnosticRun
        • DiagnosticRun.model_config
      • DiagnosticRuns
        • DiagnosticRuns.model_config
      • DiagnosticReport
        • DiagnosticReport.model_config
      • DiagnosticActivity
        • DiagnosticActivity.model_config
      • DiagnosticTrace
        • DiagnosticTrace.model_config
      • DiagnosticChange
        • DiagnosticChange.model_config
      • DiagnosticComparison
        • DiagnosticComparison.model_config
    • sampling
      • HealthSampler
        • HealthSampler.record_once()
    • service
  • Application state
    • app_state
      • AppState
        • AppState.lock
        • AppState.is_dirty()
        • AppState.clear_dirty()
    • changeset
      • ChangeSet
        • ChangeSet.is_empty()
        • ChangeSet.add_setting()
        • ChangeSet.add_server()
        • ChangeSet.add_plugin()
        • ChangeSet.add_user()
        • ChangeSet.merge()
    • maintenance
      • MaintenanceGuard
    • models
      • json_equal()
      • PersistentRecord
        • PersistentRecord.model_config
      • EntityStateMap
      • ServerConfigState
        • ServerConfigState.model_config
      • ServerState
        • ServerState.servers
      • PluginInfoState
        • PluginInfoState.model_config
      • PluginState
        • PluginState.plugins
      • UserInfoState
        • UserInfoState.model_config
      • UserState
        • UserState.users
      • SchedulerState
      • BanItem
        • BanItem.model_config
      • RuntimePlayer
        • RuntimePlayer.model_config
      • ServerRuntimeInfo
        • ServerRuntimeInfo.model_config
      • RuntimeState
        • RuntimeState.update_server_runtime()
    • revision
      • StateRevision
        • StateRevision.model_config
      • RevisionStamp
      • RevisionClock
    • settings
      • SettingsRecord
        • SettingsRecord.model_config
      • GeneralSettings
        • GeneralSettings.model_config
      • PathsSettings
        • PathsSettings.model_config
      • RetentionSettings
        • RetentionSettings.model_config
      • MonitoringSettings
        • MonitoringSettings.model_config
      • SecuritySettings
        • SecuritySettings.model_config
      • WebSettings
        • WebSettings.model_config
      • LifecycleSettings
        • LifecycleSettings.model_config
      • SchedulerSettings
        • SchedulerSettings.model_config
      • BackupDestination
        • BackupDestination.model_config
      • BackupSchedule
        • BackupSchedule.model_config
      • ScheduledTask
        • ScheduledTask.model_config
      • BackupSettings
        • BackupSettings.model_config
      • SettingsState
        • SettingsState.model_config
        • SettingsState.create_defaults()
        • SettingsState.get()
        • SettingsState.set()
        • SettingsState.to_dict()
        • SettingsState.from_dict()
        • SettingsState.model_post_init()
    • updates
      • Unset
      • ServerUpdate
        • ServerUpdate.model_config
      • UserUpdate
        • UserUpdate.model_config
      • PluginUpdate
        • PluginUpdate.model_config
      • AccountPatch
        • AccountPatch.model_config
  • Application services
    • lifecycle
      • LifecyclePhase
      • is_application_ready()
      • run_stage()
    • metrics_models
      • ServerMetrics
        • ServerMetrics.model_config
      • MetricsSample
        • MetricsSample.model_config
      • MetricsSnapshot
        • MetricsSnapshot.model_config
    • metrics_service
      • ResourceMonitor
        • ResourceMonitor.start()
        • ResourceMonitor.stop()
        • ResourceMonitor.shutdown()
    • plugin_service
      • PluginService
        • PluginService.get_plugin_state()
        • PluginService.register_or_update_plugin()
        • PluginService.set_enabled()
        • PluginService.get_setting()
    • server_service
      • ServerService
        • ServerService.get_server_state()
        • ServerService.register_or_update_server()
        • ServerService.update_setting()
        • ServerService.set_autostart()
        • ServerService.set_autoupdate()
        • ServerService.add_server_ban()
        • ServerService.remove_server_ban()
        • ServerService.get_server_bans()
    • settings_service
      • migrate_bootstrap_cors()
      • SettingsService
        • SettingsService.get()
        • SettingsService.update_setting()
        • SettingsService.get_all_settings()
    • task_service
    • user_service
      • UserService
        • UserService.get_user_state()
        • UserService.list_users()
        • UserService.change_password()
        • UserService.reset_password()
        • UserService.create_registration_token()
        • UserService.validate_registration_token()
        • UserService.register_or_update_user()
        • UserService.update_account()
        • UserService.create_account()
  • Storage and repositories
    • backup
      • default_serializer()
      • get_current_db_revision()
      • get_backup_metadata()
      • backup_database()
      • restore_database()
    • database
    • models
      • User
      • Setting
      • PluginSetting
      • Server
      • ServerBan
      • Plugin
      • RegistrationToken
      • Player
      • DiagnosticHistoryRow
      • AuditLog
      • Schedule
      • ScheduleRun
      • AccessRevision
      • AccountServerAccess
      • ServerAccessGrant
      • IntegrationToken
      • LoginSession
      • AccountSecurity
      • AuthThrottle
      • AuthSecurityEvent
      • TrustedDevice
      • PasskeyCredential
      • PasskeyChallenge
    • repositories.audit_log
      • AuditEntry
        • AuditEntry.model_config
      • AuditLogRepository
        • AuditLogRepository.create_audit_log()
        • AuditLogRepository.get_all_logs()
    • repositories.ban
      • ServerBanRepository
        • ServerBanRepository.add_or_update_ban()
        • ServerBanRepository.remove_ban()
        • ServerBanRepository.get_bans()
    • repositories.player
      • PlayerRepository
        • PlayerRepository.get_all_players()
        • PlayerRepository.save_players()
    • repositories.plugin
      • PluginRepository
        • PluginRepository.get_all_plugins()
        • PluginRepository.save_plugin()
        • PluginRepository.delete_plugin()
    • repositories.plugin_settings
    • repositories.scheduler
    • repositories.server
      • ServerRepository
        • ServerRepository.get_all_servers()
        • ServerRepository.get_server_by_name()
        • ServerRepository.save_server()
        • ServerRepository.delete_server()
    • repositories.settings
      • SettingsRepository
        • SettingsRepository.get_all_settings()
        • SettingsRepository.save_settings()
    • repositories.user
      • UserRepository
        • UserRepository.get_all_users()
        • UserRepository.get_user_by_username()
        • UserRepository.get_user_by_id()
        • UserRepository.save_user()
        • UserRepository.delete_user()
        • UserRepository.digest_token()
        • UserRepository.get_registration_token()
        • UserRepository.get_registration_token_for_update()
        • UserRepository.create_registration_token()
        • UserRepository.create_user()
        • UserRepository.delete_registration_token()
        • UserRepository.update_password()
        • UserRepository.count_active_admins()
    • storage
      • Storage
        • Storage.diagnostic_snapshot()
        • Storage.write_lock
        • Storage.subscribe()
        • Storage.unsubscribe()
        • Storage.transaction()
        • Storage.commit_record()
        • Storage.apply_changeset()
        • Storage.load_state()
        • Storage.save_players()
        • Storage.get_all_players()
        • Storage.save_state()
        • Storage.delete_server()
        • Storage.flush()
  • Web runtime
    • app
      • create_web_app()
    • contract
      • normalize_contract()
      • export_contract()
      • contract_changes()
      • main()
    • control
      • ControlRecord
        • ControlRecord.model_config
    • errors
      • configure_errors()
    • lifespan
      • application_lifespan()
    • middleware.configure
      • registration_privacy()
      • security_headers()
      • configure_middleware()
    • middleware.lifecycle
    • process
      • WebProcessPaths
        • WebProcessPaths.model_config
      • verify_web_owner()
      • force_stop_verified()
    • runtime
      • RuntimeStatus
        • RuntimeStatus.model_config
      • ShutdownRequest
        • ShutdownRequest.model_config
      • ShutdownResponse
        • ShutdownResponse.model_config
      • WebRunOptions
        • WebRunOptions.model_config
    • static
      • CachedStaticFiles
        • CachedStaticFiles.get_response()
      • mount_static()
    • Windows service host
  • Request and response models
    • addon
      • Subpack
        • Subpack.model_config
      • InstalledAddon
        • InstalledAddon.model_config
      • InstalledAddons
        • InstalledAddons.model_config
      • ListAvailableAddonsRequest
        • ListAvailableAddonsRequest.model_config
      • ListAvailableAddonsResponse
        • ListAvailableAddonsResponse.model_config
      • ImportAddonRequest
        • ImportAddonRequest.model_config
      • ImportAddonResponse
        • ImportAddonResponse.model_config
      • ListInstalledAddonsRequest
        • ListInstalledAddonsRequest.model_config
      • ListInstalledAddonsResponse
        • ListInstalledAddonsResponse.model_config
      • EnableAddonRequest
        • EnableAddonRequest.model_config
      • EnableAddonResponse
        • EnableAddonResponse.model_config
      • DisableAddonRequest
        • DisableAddonRequest.model_config
      • DisableAddonResponse
        • DisableAddonResponse.model_config
      • UpdateSubpackRequest
        • UpdateSubpackRequest.model_config
      • UpdateSubpackResponse
        • UpdateSubpackResponse.model_config
      • UninstallAddonRequest
        • UninstallAddonRequest.model_config
      • UninstallAddonResponse
        • UninstallAddonResponse.model_config
      • ReorderAddonsRequest
        • ReorderAddonsRequest.model_config
      • ReorderAddonsResponse
        • ReorderAddonsResponse.model_config
    • allowlist
      • AllowlistPlayer
        • AllowlistPlayer.model_config
      • AllowlistRemovalDetails
        • AllowlistRemovalDetails.model_config
      • AddToAllowlistRequest
        • AddToAllowlistRequest.model_config
      • AddToAllowlistResponse
        • AddToAllowlistResponse.model_config
      • GetAllowlistRequest
        • GetAllowlistRequest.model_config
      • GetAllowlistResponse
        • GetAllowlistResponse.model_config
      • RemoveFromAllowlistRequest
        • RemoveFromAllowlistRequest.model_config
      • RemoveFromAllowlistResponse
        • RemoveFromAllowlistResponse.model_config
    • api_contract
      • get_contract()
      • validate_contract()
    • application
      • ListAvailableWorldsRequest
        • ListAvailableWorldsRequest.model_config
      • ListAvailableWorldsResponse
        • ListAvailableWorldsResponse.model_config
      • GetAllServersDataRequest
        • GetAllServersDataRequest.model_config
      • GetAllServersDataResponse
        • GetAllServersDataResponse.model_config
      • GetSystemAndAppInfoRequest
        • GetSystemAndAppInfoRequest.model_config
      • GetSystemAndAppInfoResponse
        • GetSystemAndAppInfoResponse.model_config
      • UpdateServerStatusesRequest
        • UpdateServerStatusesRequest.model_config
      • UpdateServerStatusesResponse
        • UpdateServerStatusesResponse.model_config
    • backup_restore
      • ListBackupFilesRequest
        • ListBackupFilesRequest.model_config
      • ListBackupFilesResponse
        • ListBackupFilesResponse.model_config
      • BackupWorldRequest
        • BackupWorldRequest.model_config
      • BackupWorldResponse
        • BackupWorldResponse.model_config
      • BackupConfigFileRequest
        • BackupConfigFileRequest.model_config
      • BackupConfigFileResponse
        • BackupConfigFileResponse.model_config
      • BackupAllRequest
        • BackupAllRequest.model_config
      • BackupAllResponse
        • BackupAllResponse.model_config
      • RestoreAllRequest
        • RestoreAllRequest.model_config
      • RestoreAllResponse
        • RestoreAllResponse.model_config
      • RestoreWorldRequest
        • RestoreWorldRequest.model_config
      • RestoreWorldResponse
        • RestoreWorldResponse.model_config
      • RestoreConfigFileRequest
        • RestoreConfigFileRequest.model_config
      • RestoreConfigFileResponse
        • RestoreConfigFileResponse.model_config
      • PruneOldBackupsRequest
        • PruneOldBackupsRequest.model_config
      • PruneOldBackupsResponse
        • PruneOldBackupsResponse.model_config
      • CreateSnapshotRequest
        • CreateSnapshotRequest.model_config
      • CreateSnapshotResponse
        • CreateSnapshotResponse.model_config
      • ListSnapshotsRequest
        • ListSnapshotsRequest.model_config
      • SnapshotReuseRequest
        • SnapshotReuseRequest.model_config
      • ListSnapshotsResponse
        • ListSnapshotsResponse.model_config
      • InspectSnapshotRequest
        • InspectSnapshotRequest.model_config
      • InspectSnapshotResponse
        • InspectSnapshotResponse.model_config
      • PlanSnapshotRestoreRequest
        • PlanSnapshotRestoreRequest.model_config
      • PlanSnapshotRestoreResponse
        • PlanSnapshotRestoreResponse.model_config
      • RestoreSnapshotRequest
        • RestoreSnapshotRequest.model_config
      • RestoreSnapshotResponse
        • RestoreSnapshotResponse.model_config
      • RestoreRecoveryResponse
        • RestoreRecoveryResponse.model_config
      • BackupHealthResponse
        • BackupHealthResponse.model_config
      • ManageSnapshotRequest
        • ManageSnapshotRequest.model_config
      • DeleteSnapshotRequest
        • DeleteSnapshotRequest.model_config
      • ManageSnapshotResponse
        • ManageSnapshotResponse.model_config
      • PrepareBackupCopyRequest
        • PrepareBackupCopyRequest.model_config
      • PrepareBackupCopyResponse
        • PrepareBackupCopyResponse.model_config
      • SnapshotReuseResponse
        • SnapshotReuseResponse.model_config
      • CleanupBackupDestinationRequest
        • CleanupBackupDestinationRequest.model_config
      • CleanupBackupDestinationResponse
        • CleanupBackupDestinationResponse.model_config
      • RecoveryReportResponse
        • RecoveryReportResponse.model_config
    • ban
      • BanInfo
        • BanInfo.model_config
      • AddServerBanRequest
        • AddServerBanRequest.model_config
      • AddServerBanResponse
        • AddServerBanResponse.model_config
      • RemoveServerBanRequest
        • RemoveServerBanRequest.model_config
      • RemoveServerBanResponse
        • RemoveServerBanResponse.model_config
      • GetServerBansRequest
        • GetServerBansRequest.model_config
      • GetServerBansResponse
        • GetServerBansResponse.model_config
    • common
      • APIRequest
        • APIRequest.model_config
      • APIResponse
        • APIResponse.model_config
      • APIErrorResponse
        • APIErrorResponse.model_config
      • SuccessResponse
        • SuccessResponse.model_config
      • ActionResponse
        • ActionResponse.model_config
      • PlayerInfo
        • PlayerInfo.model_config
      • StateRevision
        • StateRevision.model_config
      • ServerSummary
        • ServerSummary.model_config
      • ErrorEnvelope
        • ErrorEnvelope.model_config
      • PartialResponse
        • PartialResponse.model_config
    • diagnostics
      • GetApplicationDiagnosticsRequest
        • GetApplicationDiagnosticsRequest.model_config
      • GetApplicationDiagnosticsResponse
        • GetApplicationDiagnosticsResponse.model_config
      • GetDiagnosticHistoryRequest
        • GetDiagnosticHistoryRequest.model_config
      • GetDiagnosticHistoryResponse
        • GetDiagnosticHistoryResponse.model_config
      • GetDiagnosticReportRequest
        • GetDiagnosticReportRequest.model_config
      • GetDiagnosticReportResponse
        • GetDiagnosticReportResponse.model_config
      • GetDiagnosticRunsRequest
        • GetDiagnosticRunsRequest.model_config
      • GetDiagnosticRunsResponse
        • GetDiagnosticRunsResponse.model_config
      • GetDiagnosticTraceRequest
        • GetDiagnosticTraceRequest.model_config
      • GetDiagnosticTraceResponse
        • GetDiagnosticTraceResponse.model_config
      • CompareDiagnosticSnapshotsRequest
        • CompareDiagnosticSnapshotsRequest.model_config
      • CompareDiagnosticSnapshotsResponse
        • CompareDiagnosticSnapshotsResponse.model_config
      • GetDiagnosticActivityRequest
        • GetDiagnosticActivityRequest.model_config
      • GetDiagnosticActivityResponse
        • GetDiagnosticActivityResponse.model_config
    • failures
    • install
      • InstallNewServerRequest
        • InstallNewServerRequest.model_config
      • InstallNewServerResponse
        • InstallNewServerResponse.model_config
      • UpdateServerRequest
        • UpdateServerRequest.model_config
      • UpdateServerResponse
        • UpdateServerResponse.model_config
    • misc
      • PruneDownloadCacheRequest
        • PruneDownloadCacheRequest.model_config
      • PruneDownloadCacheResponse
        • PruneDownloadCacheResponse.model_config
    • permissions
      • PlayerPermission
        • PlayerPermission.model_config
      • SetPermissionsRequest
        • SetPermissionsRequest.model_config
      • SetPermissionsResponse
        • SetPermissionsResponse.model_config
      • GetPermissionsRequest
        • GetPermissionsRequest.model_config
      • GetPermissionsResponse
        • GetPermissionsResponse.model_config
    • player
      • PlayerScanDetails
        • PlayerScanDetails.model_config
      • PlayerScanError
        • PlayerScanError.model_config
      • AddPlayersManuallyRequest
        • AddPlayersManuallyRequest.model_config
      • AddPlayersManuallyResponse
        • AddPlayersManuallyResponse.model_config
      • GetAllKnownPlayersRequest
        • GetAllKnownPlayersRequest.model_config
      • GetAllKnownPlayersResponse
        • GetAllKnownPlayersResponse.model_config
      • ScanAndUpdatePlayerDbRequest
        • ScanAndUpdatePlayerDbRequest.model_config
      • ScanAndUpdatePlayerDbResponse
        • ScanAndUpdatePlayerDbResponse.model_config
    • plugins
      • PluginInfo
        • PluginInfo.model_config
      • GetPluginStatusesRequest
        • GetPluginStatusesRequest.model_config
      • GetPluginStatusesResponse
        • GetPluginStatusesResponse.model_config
      • SetPluginStatusRequest
        • SetPluginStatusRequest.model_config
      • SetPluginStatusResponse
        • SetPluginStatusResponse.model_config
      • ReloadSinglePluginRequest
        • ReloadSinglePluginRequest.model_config
      • ReloadSinglePluginResponse
        • ReloadSinglePluginResponse.model_config
      • ReloadPluginsRequest
        • ReloadPluginsRequest.model_config
      • ReloadPluginsResponse
        • ReloadPluginsResponse.model_config
      • TriggerExternalAppEventRequest
        • TriggerExternalAppEventRequest.model_config
      • EventDispatchSummary
        • EventDispatchSummary.model_config
      • TriggerExternalAppEventResponse
        • TriggerExternalAppEventResponse.model_config
      • PluginSettingsScope
        • PluginSettingsScope.model_config
      • GetPluginSettingRequest
        • GetPluginSettingRequest.model_config
      • GetPluginSettingResponse
        • GetPluginSettingResponse.model_config
      • SetPluginSettingRequest
        • SetPluginSettingRequest.model_config
      • SetPluginSettingResponse
        • SetPluginSettingResponse.model_config
      • GetPluginSettingsRequest
        • GetPluginSettingsRequest.model_config
      • GetPluginSettingsResponse
        • GetPluginSettingsResponse.model_config
      • UpdatePluginSettingsRequest
        • UpdatePluginSettingsRequest.model_config
      • PluginSettingsPayload
        • PluginSettingsPayload.model_config
    • properties
      • GetPropertiesRequest
        • GetPropertiesRequest.model_config
      • GetPropertiesResponse
        • GetPropertiesResponse.model_config
      • GetRawPropertiesRequest
        • GetRawPropertiesRequest.model_config
      • GetRawPropertiesResponse
        • GetRawPropertiesResponse.model_config
      • ValidatePropertyValueRequest
        • ValidatePropertyValueRequest.model_config
      • ValidatePropertyValueResponse
        • ValidatePropertyValueResponse.model_config
      • SetPropertiesRequest
        • SetPropertiesRequest.model_config
      • SetPropertiesResponse
        • SetPropertiesResponse.model_config
    • Scheduler contracts
      • ScheduleConfigurationView
        • ScheduleConfigurationView.model_config
      • ScheduleEntry
        • ScheduleEntry.model_config
      • ListSchedulesRequest
        • ListSchedulesRequest.model_config
      • ListSchedulesResponse
        • ListSchedulesResponse.model_config
      • SaveScheduleRequest
        • SaveScheduleRequest.model_config
      • DeleteScheduleRequest
        • DeleteScheduleRequest.model_config
      • ControlScheduleRequest
        • ControlScheduleRequest.model_config
      • ControlSchedulePayload
        • ControlSchedulePayload.model_config
    • server
      • StartServerRequest
        • StartServerRequest.model_config
      • StopServerRequest
        • StopServerRequest.model_config
      • RestartServerRequest
        • RestartServerRequest.model_config
      • StartServerResponse
        • StartServerResponse.model_config
      • StopServerResponse
        • StopServerResponse.model_config
      • RestartServerResponse
        • RestartServerResponse.model_config
      • GetServerSettingRequest
        • GetServerSettingRequest.model_config
      • GetServerSettingResponse
        • GetServerSettingResponse.model_config
      • SetServerSettingRequest
        • SetServerSettingRequest.model_config
      • SetServerSettingResponse
        • SetServerSettingResponse.model_config
      • SetServerCustomValueRequest
        • SetServerCustomValueRequest.model_config
      • SetServerCustomValueResponse
        • SetServerCustomValueResponse.model_config
      • GetAllServerSettingsRequest
        • GetAllServerSettingsRequest.model_config
      • GetAllServerSettingsResponse
        • GetAllServerSettingsResponse.model_config
      • GetServerSummaryRequest
        • GetServerSummaryRequest.model_config
      • GetServerSummaryResponse
        • GetServerSummaryResponse.model_config
      • SendCommandRequest
        • SendCommandRequest.model_config
      • SendCommandResponse
        • SendCommandResponse.model_config
      • DeleteServerDataRequest
        • DeleteServerDataRequest.model_config
      • DeleteServerDataResponse
        • DeleteServerDataResponse.model_config
      • SetServerStatusRequest
        • SetServerStatusRequest.model_config
      • SetServerStatusResponse
        • SetServerStatusResponse.model_config
      • UpdateServerPlayerStatsRequest
        • UpdateServerPlayerStatsRequest.model_config
      • UpdateServerPlayerStatsResponse
        • UpdateServerPlayerStatsResponse.model_config
      • GetValidServerNamesRequest
        • GetValidServerNamesRequest.model_config
      • GetValidServerNamesResponse
        • GetValidServerNamesResponse.model_config
    • settings
      • GetGlobalSettingRequest
        • GetGlobalSettingRequest.model_config
      • GetGlobalSettingResponse
        • GetGlobalSettingResponse.model_config
      • GetAllGlobalSettingsRequest
        • GetAllGlobalSettingsRequest.model_config
      • GetAllGlobalSettingsResponse
        • GetAllGlobalSettingsResponse.model_config
      • SetGlobalSettingRequest
        • SetGlobalSettingRequest.model_config
      • SetGlobalSettingResponse
        • SetGlobalSettingResponse.model_config
      • SetCustomGlobalSettingRequest
        • SetCustomGlobalSettingRequest.model_config
      • SetCustomGlobalSettingResponse
        • SetCustomGlobalSettingResponse.model_config
      • ReloadGlobalSettingsRequest
        • ReloadGlobalSettingsRequest.model_config
      • ReloadGlobalSettingsResponse
        • ReloadGlobalSettingsResponse.model_config
    • shared_contracts
      • DataContract
        • DataContract.model_config
      • FailureInfo
        • FailureInfo.model_config
      • ClassifiedFailure
        • ClassifiedFailure.model_config
      • CompletedItem
        • CompletedItem.model_config
      • SkippedItem
        • SkippedItem.model_config
      • FailedItem
        • FailedItem.model_config
      • ComponentResults
        • ComponentResults.model_config
      • CleanupResult
        • CleanupResult.model_config
      • DeliveryResult
        • DeliveryResult.model_config
      • BanMutation
        • BanMutation.model_config
      • ResourceFailure
        • ResourceFailure.model_config
      • PlayerScanError
        • PlayerScanError.model_config
      • PlayerScanDetails
        • PlayerScanDetails.model_config
      • CommittedMutationResult
        • CommittedMutationResult.model_config
    • system
      • ProcessInfo
        • ProcessInfo.model_config
      • GetServerRunningStatusRequest
        • GetServerRunningStatusRequest.model_config
      • GetServerRunningStatusResponse
        • GetServerRunningStatusResponse.model_config
      • GetBedrockProcessInfoRequest
        • GetBedrockProcessInfoRequest.model_config
      • GetBedrockProcessInfoResponse
        • GetBedrockProcessInfoResponse.model_config
      • GetApplicationHealthRequest
        • GetApplicationHealthRequest.model_config
      • HealthCheck
        • HealthCheck.model_config
      • GetApplicationHealthResponse
        • GetApplicationHealthResponse.model_config
      • MetricsSample
        • MetricsSample.model_config
      • ServerMetrics
        • ServerMetrics.model_config
      • GetApplicationMetricsRequest
        • GetApplicationMetricsRequest.model_config
      • GetApplicationMetricsResponse
        • GetApplicationMetricsResponse.model_config
    • tasks
      • TaskAcceptedResponse
        • TaskAcceptedResponse.model_config
      • TaskState
        • TaskState.model_config
      • TaskSnapshot
        • TaskSnapshot.model_config
    • web
      • CreateWebUiServiceRequest
        • CreateWebUiServiceRequest.model_config
      • CreateWebUiServiceResponse
        • CreateWebUiServiceResponse.model_config
      • EnableWebUiServiceRequest
        • EnableWebUiServiceRequest.model_config
      • EnableWebUiServiceResponse
        • EnableWebUiServiceResponse.model_config
      • DisableWebUiServiceRequest
        • DisableWebUiServiceRequest.model_config
      • DisableWebUiServiceResponse
        • DisableWebUiServiceResponse.model_config
      • RemoveWebUiServiceRequest
        • RemoveWebUiServiceRequest.model_config
      • RemoveWebUiServiceResponse
        • RemoveWebUiServiceResponse.model_config
      • GetWebUiServiceStatusRequest
        • GetWebUiServiceStatusRequest.model_config
      • GetWebUiServiceStatusResponse
        • GetWebUiServiceStatusResponse.model_config
    • websocket
      • BroadcastRequest
        • BroadcastRequest.model_config
      • BroadcastResponse
        • BroadcastResponse.model_config
      • SendToUserRequest
        • SendToUserRequest.model_config
      • SendToUserResponse
        • SendToUserResponse.model_config
      • SendToClientRequest
        • SendToClientRequest.model_config
      • SendToClientResponse
        • SendToClientResponse.model_config
      • UnregisterDataProviderRequest
        • UnregisterDataProviderRequest.model_config
      • UnregisterDataProviderResponse
        • UnregisterDataProviderResponse.model_config
      • PublishWsEventRequest
        • PublishWsEventRequest.model_config
      • PublishWsEventResponse
        • PublishWsEventResponse.model_config
    • world
      • GetWorldNameRequest
        • GetWorldNameRequest.model_config
      • GetWorldNameResponse
        • GetWorldNameResponse.model_config
      • ExportWorldRequest
        • ExportWorldRequest.model_config
      • ExportWorldResponse
        • ExportWorldResponse.model_config
      • ImportWorldRequest
        • ImportWorldRequest.model_config
      • ImportWorldResponse
        • ImportWorldResponse.model_config
      • ResetWorldRequest
        • ResetWorldRequest.model_config
      • ResetWorldResponse
        • ResetWorldResponse.model_config
  • Server components
    • addon
      • ServerAddons
        • ServerAddons.process_addon_file()
        • ServerAddons.list_installed_addons()
        • ServerAddons.enable_addon()
        • ServerAddons.update_subpack()
        • ServerAddons.disable_addon()
        • ServerAddons.reorder_addons()
        • ServerAddons.export_addon()
        • ServerAddons.remove_addon()
    • allowlist
      • ServerAllowlist
        • ServerAllowlist.get_allowlist()
        • ServerAllowlist.add_to_allowlist()
        • ServerAllowlist.remove_from_allowlist()
    • configuration
      • ServerConfiguration
        • ServerConfiguration.as_settings()
    • installation
      • ServerInstallation
        • ServerInstallation.validate_installation()
        • ServerInstallation.is_installed()
    • paths
      • ServerPaths
        • ServerPaths.bedrock_executable_name
        • ServerPaths.bedrock_executable_path
        • ServerPaths.server_log_dir
        • ServerPaths.server_log_path
        • ServerPaths.server_properties_path
        • ServerPaths.allowlist_json_path
        • ServerPaths.permissions_json_path
        • ServerPaths.server_config_dir
    • permissions
      • ServerPermissions
        • ServerPermissions.set_player_permission()
        • ServerPermissions.get_formatted_permissions()
    • player
      • ServerPlayers
        • ServerPlayers.scan_log_for_players()
        • ServerPlayers.update_online_players()
        • ServerPlayers.reset()
    • process
      • ServerProcess
        • ServerProcess.is_running()
        • ServerProcess.send_command()
        • ServerProcess.start()
        • ServerProcess.stop()
        • ServerProcess.get_process_info()
    • properties
      • validate_property_value()
      • ServerProperties
        • ServerProperties.get_server_properties()
        • ServerProperties.set_server_property()
        • ServerProperties.get_server_property()
    • resources
      • ServerResources
        • ServerResources.get_pid_file_path()
        • ServerResources.get_file_lock()
        • ServerResources.paths
    • world
      • ServerWorlds
        • ServerWorlds.extract_mcworld()
        • ServerWorlds.export_world()
        • ServerWorlds.import_world()
        • ServerWorlds.delete_world()
        • ServerWorlds.has_world_icon()
        • ServerWorlds.world_icon_filename
        • ServerWorlds.get_world_icon_filesystem_path()
  • Backups
    • archive
      • BoundedTarInfo
        • BoundedTarInfo.name
        • BoundedTarInfo.mode
        • BoundedTarInfo.uid
        • BoundedTarInfo.gid
        • BoundedTarInfo.size
        • BoundedTarInfo.mtime
        • BoundedTarInfo.chksum
        • BoundedTarInfo.type
        • BoundedTarInfo.linkname
        • BoundedTarInfo.uname
        • BoundedTarInfo.gname
        • BoundedTarInfo.devmajor
        • BoundedTarInfo.devminor
        • BoundedTarInfo.offset
        • BoundedTarInfo.offset_data
        • BoundedTarInfo.pax_headers
        • BoundedTarInfo.sparse
      • safe_name()
      • header()
      • build_payload()
      • write_archive()
      • publish_archive()
      • manifest_requirements()
      • unpack()
    • assurance
      • reconcile_cleanup()
    • catalog
      • BackupDestination
      • DirectoryDestination
      • BackupCatalog
      • ManagedBackups
        • ManagedBackups.delete_snapshot()
        • ManagedBackups.verify_snapshot()
        • ManagedBackups.maintain_backups()
    • clone
    • contents
      • BackupContentSelection
        • BackupContentSelection.model_config
    • credentials
      • protect()
      • credentials_directory()
      • atomic_bytes()
      • atomic_json()
      • locked_credential_file()
      • KeyRecord
        • KeyRecord.model_config
      • KeyStore
        • KeyStore.model_config
      • BackupCredentials
    • models
      • Record
        • Record.model_config
      • ServerSettingsExport
        • ServerSettingsExport.model_config
      • BackupFile
        • BackupFile.model_config
      • BackupManifest
        • BackupManifest.model_config
      • BackupHeader
        • BackupHeader.model_config
      • BackupVerification
        • BackupVerification.model_config
      • BackupCopy
        • BackupCopy.model_config
      • BackupSummary
        • BackupSummary.model_config
      • RestoreFileChange
        • RestoreFileChange.model_config
      • RestoreValueChange
        • RestoreValueChange.model_config
      • RestoreVolume
        • RestoreVolume.model_config
      • RestorePlan
        • RestorePlan.model_config
      • RestoreResult
        • RestoreResult.model_config
      • RestoreRecoveryState
        • RestoreRecoveryState.model_config
      • BackupHealth
        • BackupHealth.model_config
      • DestinationCleanupPlan
        • DestinationCleanupPlan.model_config
      • RecoveryReportReview
        • RecoveryReportReview.model_config
      • RecoveryReportOutcome
        • RecoveryReportOutcome.model_config
      • RecoveryReportArchive
        • RecoveryReportArchive.model_config
      • RecoveryReportDrill
        • RecoveryReportDrill.model_config
      • RecoveryReport
        • RecoveryReport.model_config
      • validate_selection_options()
    • recovery
      • sync_tree()
      • RestoreJournal
    • reports
    • selection
      • server_entries()
    • server
    • space
      • ensure_free_space()
    • spool
      • CaptureSpool
    • transfer
      • BackupUploadTooLargeError
      • open_snapshot_download()
      • import_snapshot_upload()
      • export_decrypted_snapshot()
      • list_backup_keys()
      • rotate_backup_key()
      • get_backup_emergency_kit()
    • work
      • backup_worker()
      • tree_paths()
      • FileWork
  • Scheduler
    • engine
    • runner
      • DeferredRun
      • candidate()
      • run_schedule()
      • next_attempt()
    • service
      • Scheduler
        • Scheduler.control()
    • tasks
      • BackupScheduleOptions
        • BackupScheduleOptions.model_config
      • VerifyScheduleOptions
        • VerifyScheduleOptions.model_config
      • PruneDownloadsScheduleOptions
        • PruneDownloadsScheduleOptions.model_config
      • EmptyScheduleOptions
        • EmptyScheduleOptions.model_config
      • TaskDefinition
      • TaskRegistry
        • TaskRegistry.handlers
        • TaskRegistry.get_task_definition()
        • TaskRegistry.available()
        • TaskRegistry.remove_owner()
        • TaskRegistry.register()
        • TaskRegistry.register_api_task()
    • builtin
      • register_builtin_tasks()
  • Plugins Internals
    • api_bridge
      • api_method()
      • create_app_api()
      • CapabilityNamespace
      • AppAPI
        • AppAPI.operations
        • AppAPI.events
        • AppAPI.scheduler
        • AppAPI.diagnostics
        • AppAPI.list_available_apis()
        • AppAPI.listen_for_event()
        • AppAPI.send_event()
    • app_event
      • app_event()
    • decorators
      • scheduled_task()
      • diagnostic_provider()
      • data_provider()
      • websocket_provider()
    • event_api
    • files
    • lifespan
    • operation_api
    • runtime
      • PluginRuntime
        • PluginRuntime.model_config
    • runtime_capabilities
      • run_task()
      • register_data_provider()
      • register_diagnostic_provider()
      • report_task_progress()
      • report_task_stage()
      • read_plugin_file()
      • write_plugin_file()
      • get_plugin_data_path()
      • register_scheduled_task()
      • register_api_task()
      • register_http_permission()
    • settings
    • subscription
    • task_loop
      • task_loop()
  • Utilities
    • general
      • startup_checks()
      • run_async()
      • ReentrantAsyncLock
      • get_timestamp()
      • list_content_files()
    • io
      • save_json()
      • load_json()
      • save_lines()
      • load_lines()
      • temporary_directory()
    • progress
      • progress_scope()
      • report_stage()
    • server
      • valid_server_names()
      • core_validate_server_name_format()
      • validate_server()
      • get_servers_data()
    • threads
      • WorkerSnapshot
      • check_cancellation()
      • copy_stream()
      • worker_snapshot()
    • timezones
      • resolve_timezone()
      • schedule_timezones()
Bedrock Server Manager
BSM / Documentation
  • Storage and repositories
  • View page source

Storage and repositories

Internal contributor reference. Plugins should use supported capabilities.

  • backup
  • database
  • models
  • repositories.audit_log
  • repositories.ban
  • repositories.player
  • repositories.plugin
  • repositories.plugin_settings
  • repositories.scheduler
  • repositories.server
  • repositories.settings
  • repositories.user
  • storage
Previous Next

© Copyright 2026, DMedina559.

Built with Sphinx using a theme provided by Read the Docs.