World 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.

world.export_world

await self.api.world.export_world(request: bedrock_server_manager.api.models.world.ExportWorldRequest)

• Async (Requires await): Yes

• Description: Export the server’s currently active world to a .mcworld archive.

• Returns: ExportWorldResponse

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 ExportWorldRequest
payload = {'server_name': 'example'}
request = ExportWorldRequest(**payload)
result = await self.api.world.export_world(request)
data = result.model_dump(mode="json")

• Request schema: ExportWorldRequest

• Response schema: ExportWorldResponse

• Transport error schema: APIErrorResponse Parameters:

Name	Type	Default
request	bedrock_server_manager.api.models.world.ExportWorldRequest	REQUIRED

---

world.get_world_name

await self.api.world.get_world_name(request: bedrock_server_manager.api.models.world.GetWorldNameRequest)

• Async (Requires await): Yes

• Description: Return the configured world name (level-name) for a server.

• Returns: GetWorldNameResponse

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 GetWorldNameRequest
payload = {'server_name': 'example'}
request = GetWorldNameRequest(**payload)
result = await self.api.world.get_world_name(request)
data = result.model_dump(mode="json")

• Request schema: GetWorldNameRequest

• Response schema: GetWorldNameResponse

• Transport error schema: APIErrorResponse Parameters:

Name	Type	Default
request	bedrock_server_manager.api.models.world.GetWorldNameRequest	REQUIRED

---

world.import_world

await self.api.world.import_world(request: bedrock_server_manager.api.models.world.ImportWorldRequest)

• Async (Requires await): Yes

• Description: Import a world from a .mcworld file, replacing the active world.

• Returns: ImportWorldResponse

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 ImportWorldRequest
payload = {...}  # Supply required request fields below.
request = ImportWorldRequest(**payload)
result = await self.api.world.import_world(request)
data = result.model_dump(mode="json")

• Request schema: ImportWorldRequest

• Response schema: ImportWorldResponse

• Transport error schema: APIErrorResponse Parameters:

Name	Type	Default
request	bedrock_server_manager.api.models.world.ImportWorldRequest	REQUIRED

---

world.reset_world

await self.api.world.reset_world(request: bedrock_server_manager.api.models.world.ResetWorldRequest)

• Async (Requires await): Yes

• Description: Resets the server’s world by deleting the active world directory.

• Returns: ResetWorldResponse

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 ResetWorldRequest
payload = {'server_name': 'example'}
request = ResetWorldRequest(**payload)
result = await self.api.world.reset_world(request)
data = result.model_dump(mode="json")

• Request schema: ResetWorldRequest

• Response schema: ResetWorldResponse

• Transport error schema: APIErrorResponse Parameters:

Name	Type	Default
request	bedrock_server_manager.api.models.world.ResetWorldRequest	REQUIRED