Application plugin APIs
Generated from registered core contracts.
This list contains all functions available to plugins via the self.api object.
For an updated list of available APIs, please download and run the api_docs_generator plugin.
application.get_all_servers_data
await self.api.application.get_all_servers_data(request: bedrock_server_manager.api.models.application.GetAllServersDataRequest)
Async (Requires await): Yes
Description: Return status and version for all detected servers.
Returns:
GetAllServersDataResponse
Runtime context and plugin identity are injected by the bridge. Failures raise application exceptions; plugin cancellation raises APICancelledError.
from bedrock_server_manager.api.models import GetAllServersDataRequest
payload = {}
request = GetAllServersDataRequest(**payload)
result = await self.api.application.get_all_servers_data(request)
data = result.model_dump(mode="json")
Request schema: GetAllServersDataRequest
Response schema: GetAllServersDataResponse
Transport error schema: APIErrorResponse Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
application.get_system_and_app_info
self.api.application.get_system_and_app_info(request: bedrock_server_manager.api.models.application.GetSystemAndAppInfoRequest)
Async (Requires await): No
Description: Return basic system and application information.
Returns:
GetSystemAndAppInfoResponse
Runtime context and plugin identity are injected by the bridge. Failures raise application exceptions; plugin cancellation raises APICancelledError.
from bedrock_server_manager.api.models import GetSystemAndAppInfoRequest
payload = {}
request = GetSystemAndAppInfoRequest(**payload)
result = self.api.application.get_system_and_app_info(request)
data = result.model_dump(mode="json")
Request schema: GetSystemAndAppInfoRequest
Response schema: GetSystemAndAppInfoResponse
Transport error schema: APIErrorResponse Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
application.list_available_worlds
await self.api.application.list_available_worlds(request: bedrock_server_manager.api.models.application.ListAvailableWorldsRequest)
Async (Requires await): Yes
Description: Lists available .mcworld files from the content directory.
Returns:
ListAvailableWorldsResponse
Runtime context and plugin identity are injected by the bridge. Failures raise application exceptions; plugin cancellation raises APICancelledError.
from bedrock_server_manager.api.models import ListAvailableWorldsRequest
payload = {}
request = ListAvailableWorldsRequest(**payload)
result = await self.api.application.list_available_worlds(request)
data = result.model_dump(mode="json")
Request schema: ListAvailableWorldsRequest
Response schema: ListAvailableWorldsResponse
Transport error schema: APIErrorResponse Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|