Server 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.
server.get_all_settings
await self.api.server.get_all_settings(request: bedrock_server_manager.api.models.server.GetAllServerSettingsRequest)
Async (Requires await): Yes
Description: Reads the entire persisted configurationuration for a specific server from its
Returns:
GetAllServerSettingsResponse
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 GetAllServerSettingsRequest
payload = {'server_name': 'example'}
request = GetAllServerSettingsRequest(**payload)
result = await self.api.server.get_all_settings(request)
data = result.model_dump(mode="json")
Request schema: GetAllServerSettingsRequest
Response schema: GetAllServerSettingsResponse
Transport error schema: APIErrorResponse Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
server.get_setting
await self.api.server.get_setting(request: bedrock_server_manager.api.models.server.GetServerSettingRequest)
Async (Requires await): Yes
Description: Reads any value from a server’s specific persisted configuration
Returns:
GetServerSettingResponse
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 GetServerSettingRequest
payload = {...} # Supply required request fields below.
request = GetServerSettingRequest(**payload)
result = await self.api.server.get_setting(request)
data = result.model_dump(mode="json")
Request schema: GetServerSettingRequest
Response schema: GetServerSettingResponse
Transport error schema: APIErrorResponse Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
server.get_summary
await self.api.server.get_summary(request: bedrock_server_manager.api.models.server.GetServerSummaryRequest)
Async (Requires await): Yes
Description: Return the summary information for a specific server.
Returns:
GetServerSummaryResponse
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 GetServerSummaryRequest
payload = {'server_name': 'example'}
request = GetServerSummaryRequest(**payload)
result = await self.api.server.get_summary(request)
data = result.model_dump(mode="json")
Request schema: GetServerSummaryRequest
Response schema: GetServerSummaryResponse
Transport error schema: APIErrorResponse Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
server.get_valid_names
await self.api.server.get_valid_names(request: bedrock_server_manager.api.models.server.GetValidServerNamesRequest)
Async (Requires await): Yes
Description: Return current registered server names without sampling processes.
Returns:
GetValidServerNamesResponse
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 GetValidServerNamesRequest
payload = {}
request = GetValidServerNamesRequest(**payload)
result = await self.api.server.get_valid_names(request)
data = result.model_dump(mode="json")
Request schema: GetValidServerNamesRequest
Response schema: GetValidServerNamesResponse
Transport error schema: APIErrorResponse Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
server.restart
await self.api.server.restart(request: bedrock_server_manager.api.models.server.RestartServerRequest)
Async (Requires await): Yes
Description: Orchestrate stop/start; abort on cancellation or either phase failing.
Returns:
RestartServerResponse
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 RestartServerRequest
payload = {'server_name': 'example'}
request = RestartServerRequest(**payload)
result = await self.api.server.restart(request)
data = result.model_dump(mode="json")
Request schema: RestartServerRequest
Response schema: RestartServerResponse
Transport error schema: APIErrorResponse Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
server.send_command
await self.api.server.send_command(request: bedrock_server_manager.api.models.server.SendCommandRequest)
Async (Requires await): Yes
Description: Sends a command to a running Bedrock server.
Returns:
SendCommandResponse
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 SendCommandRequest
payload = {...} # Supply required request fields below.
request = SendCommandRequest(**payload)
result = await self.api.server.send_command(request)
data = result.model_dump(mode="json")
Request schema: SendCommandRequest
Response schema: SendCommandResponse
Transport error schema: APIErrorResponse Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
server.set_custom_value
await self.api.server.set_custom_value(request: bedrock_server_manager.api.models.server.SetServerCustomValueRequest)
Async (Requires await): Yes
Description: Writes a key-value pair to the ‘custom’ section of a server’s specific
Returns:
SetServerCustomValueResponse
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 SetServerCustomValueRequest
payload = {...} # Supply required request fields below.
request = SetServerCustomValueRequest(**payload)
result = await self.api.server.set_custom_value(request)
data = result.model_dump(mode="json")
Request schema: SetServerCustomValueRequest
Response schema: SetServerCustomValueResponse
Transport error schema: APIErrorResponse Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
server.start
await self.api.server.start(request: bedrock_server_manager.api.models.server.StartServerRequest)
Async (Requires await): Yes
Description: Start an offline server under its lock, dispatching hooks only when needed.
Returns:
StartServerResponse
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 StartServerRequest
payload = {'server_name': 'example'}
request = StartServerRequest(**payload)
result = await self.api.server.start(request)
data = result.model_dump(mode="json")
Request schema: StartServerRequest
Response schema: StartServerResponse
Transport error schema: APIErrorResponse Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
server.stop
await self.api.server.stop(request: bedrock_server_manager.api.models.server.StopServerRequest)
Async (Requires await): Yes
Description: Stop a server, or report that it is already stopped; failures raise.
Returns:
StopServerResponse
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 StopServerRequest
payload = {'server_name': 'example'}
request = StopServerRequest(**payload)
result = await self.api.server.stop(request)
data = result.model_dump(mode="json")
Request schema: StopServerRequest
Response schema: StopServerResponse
Transport error schema: APIErrorResponse Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|