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

addon.disable_addon

await self.api.addon.disable_addon(request: bedrock_server_manager.api.models.addon.DisableAddonRequest)

• Async (Requires await): Yes

• Description: Disables an active addon for a server’s active world, preserving files.

• Returns: DisableAddonResponse

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

• Request schema: DisableAddonRequest

• Response schema: DisableAddonResponse

• Transport error schema: APIErrorResponse Parameters:

Name	Type	Default
request	bedrock_server_manager.api.models.addon.DisableAddonRequest	REQUIRED

---

addon.enable_addon

await self.api.addon.enable_addon(request: bedrock_server_manager.api.models.addon.EnableAddonRequest)

• Async (Requires await): Yes

• Description: Enables a disabled addon for a server’s active world.

• Returns: EnableAddonResponse

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

• Request schema: EnableAddonRequest

• Response schema: EnableAddonResponse

• Transport error schema: APIErrorResponse Parameters:

Name	Type	Default
request	bedrock_server_manager.api.models.addon.EnableAddonRequest	REQUIRED

---

addon.import_addon

await self.api.addon.import_addon(request: bedrock_server_manager.api.models.addon.ImportAddonRequest)

• Async (Requires await): Yes

• Description: Installs an addon to a specified Bedrock server.

• Returns: ImportAddonResponse

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

• Request schema: ImportAddonRequest

• Response schema: ImportAddonResponse

• Transport error schema: APIErrorResponse Parameters:

Name	Type	Default
request	bedrock_server_manager.api.models.addon.ImportAddonRequest	REQUIRED

---

addon.list_available_addons

await self.api.addon.list_available_addons(request: bedrock_server_manager.api.models.addon.ListAvailableAddonsRequest)

• Async (Requires await): Yes

• Description: Lists available .mcaddon and .mcpack files from the content directory.

• Returns: ListAvailableAddonsResponse

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 ListAvailableAddonsRequest
payload = {}
request = ListAvailableAddonsRequest(**payload)
result = await self.api.addon.list_available_addons(request)
data = result.model_dump(mode="json")

• Request schema: ListAvailableAddonsRequest

• Response schema: ListAvailableAddonsResponse

• Transport error schema: APIErrorResponse Parameters:

Name	Type	Default
request	bedrock_server_manager.api.models.addon.ListAvailableAddonsRequest	REQUIRED

---

addon.list_installed_addons

await self.api.addon.list_installed_addons(request: bedrock_server_manager.api.models.addon.ListInstalledAddonsRequest)

• Async (Requires await): Yes

• Description: Lists all addons for a server’s active world.

• Returns: ListInstalledAddonsResponse

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

• Request schema: ListInstalledAddonsRequest

• Response schema: ListInstalledAddonsResponse

• Transport error schema: APIErrorResponse Parameters:

Name	Type	Default
request	bedrock_server_manager.api.models.addon.ListInstalledAddonsRequest	REQUIRED

---

addon.reorder_addons

await self.api.addon.reorder_addons(request: bedrock_server_manager.api.models.addon.ReorderAddonsRequest)

• Async (Requires await): Yes

• Description: Reorder the active addons for a server’s active world.

• Returns: ReorderAddonsResponse

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

• Request schema: ReorderAddonsRequest

• Response schema: ReorderAddonsResponse

• Transport error schema: APIErrorResponse Parameters:

Name	Type	Default
request	bedrock_server_manager.api.models.addon.ReorderAddonsRequest	REQUIRED