Plugins 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.
plugins.get_plugin_setting
await self.api.plugins.get_plugin_setting(request: bedrock_server_manager.api.models.plugins.GetPluginSettingRequest)
Async (Requires await): Yes
Description: Read settings scoped to the bridge-injected plugin identity.
Returns:
GetPluginSettingResponse
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 GetPluginSettingRequest
payload = {}
request = GetPluginSettingRequest(**payload)
result = await self.api.plugins.get_plugin_setting(request)
data = result.model_dump(mode="json")
Request schema: GetPluginSettingRequest
Response schema: GetPluginSettingResponse
Transport error schema: APIErrorResponse Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
plugins.get_plugin_statuses
await self.api.plugins.get_plugin_statuses(request: bedrock_server_manager.api.models.plugins.GetPluginStatusesRequest)
Async (Requires await): Yes
Description: Return the statuses and metadata of all discovered plugins.
Returns:
GetPluginStatusesResponse
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 GetPluginStatusesRequest
payload = {}
request = GetPluginStatusesRequest(**payload)
result = await self.api.plugins.get_plugin_statuses(request)
data = result.model_dump(mode="json")
Request schema: GetPluginStatusesRequest
Response schema: GetPluginStatusesResponse
Transport error schema: APIErrorResponse Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
plugins.set_plugin_setting
await self.api.plugins.set_plugin_setting(request: bedrock_server_manager.api.models.plugins.SetPluginSettingRequest)
Async (Requires await): Yes
Description: Persist settings scoped to the bridge-injected plugin identity.
Returns:
SetPluginSettingResponse
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 SetPluginSettingRequest
payload = {...} # Supply required request fields below.
request = SetPluginSettingRequest(**payload)
result = await self.api.plugins.set_plugin_setting(request)
data = result.model_dump(mode="json")
Request schema: SetPluginSettingRequest
Response schema: SetPluginSettingResponse
Transport error schema: APIErrorResponse Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|